public.javadoc.org.spincast.plugins.undertow.SpincastUndertowServer.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastUndertowServer (org.spincast:spincast-framework 1.2.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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

All Methods Instance Methods Concrete Methods 

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)
Adds cookies.



void
addHttpAuthentication(String realmName,
                     String username,
                     String password)
Adds a user to an HTTP protected realm.



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)
Adds a static resource to serve directly by the server.



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


void
createHttpAuthenticationRealm(String pathPrefix,
                             String realmName)
Creates HTTP authentication protection (realm) for the
 specified path prefix.



protected Path
createUndertowTempDir() 


protected WebsocketEndpointHandler
createUndertowWebsocketEndpointHandler(String endpointId,
                                      WebsocketEndpointHandler appHandler) 


void
end(Object exchange)
Ends the exchange.



void
flushBytes(Object exchange,
          byte[] bytes,
          boolean end)
Flushes some bytes to the response.



boolean
forceRequestSizeValidation(Object exchangeObj)
Is the request size valid?



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)
Gets the best Content-Type to use for the current request.



protected String
getCookieEncoding() 


protected CookieFactory
getCookieFactory() 


Map<String,String>
getCookies(Object exchange)
Gets the request cookies values.



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)
The form data, if any.



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


protected FrontController
getFrontController() 


String
getFullUrlOriginal(Object exchangeObj)
The full encoded URL of the original, non proxied, request, including the queryString.



String
getFullUrlOriginal(Object exchangeObj,
                  boolean keepCacheBusters)
The full encoded URL of the original, non proxied, request, including the queryString.



String
getFullUrlProxied(Object exchangeObj)
The full encoded URL of the potentially proxied request, including the queryString.



String
getFullUrlProxied(Object exchangeObj,
                 boolean keepCacheBusters)
The full encoded URL of the potentially proxied request, including the queryString.



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()
Returns the existing HTTP authentication realms, the
 key being the realm's name and the value being the
 prefix path associated to this realm.



protected io.undertow.server.HttpHandler
getHttpAuthHandlerNextHandler() 


protected Map<String,SpincastHttpAuthIdentityManager>
getHttpAuthIdentityManagersByRealmName() 


HttpMethod
getHttpMethod(Object exchange)
Gets the HTTP method associated with the request.



String
getIp(Object exchangeObj)
Gets the IP of the current request.



protected int
getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer() 


protected SpincastHttpAuthIdentityManager
getOrCreateHttpAuthIdentityManagersByRealmName(String realmName) 


Map<String,List<String>>
getQueryStringParams(Object exchange)
Gets the queryString parameters.



InputStream
getRawInputStream(Object exchangeObj)
The raw InputStream of the current request.



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)
Gets the request scheme, "http" for example.



Map<String,List<String>>
getResponseHeaders(Object exchangeObj)
Gets the response headers.



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)
Gets a static resource served directly by the server, using its path.



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


Set<StaticResource<?>>
getStaticResourcesServed()
Gets all static resource served directly by the server.



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


Map<String,List<UploadedFile>>
getUploadedFiles(Object exchangeObj)
The uploaded files, if any.



protected Object
getWebsocketEndpointCreationLock(String endpointId)
Gets the creation/close lock for a specific Websocket endpoint.



WebsocketEndpointManager
getWebsocketEndpointManager(String endpointId)
Returns the manager for a Websockets endpoint.



List<WebsocketEndpointManager>
getWebsocketEndpointManagers()
Returns the managers of the existing Websockets endpoints.



protected Map<String,WebsocketEndpoint>
getWebsocketEndpointsMap() 


boolean
isResponseClosed(Object exchange)
Is the response closed?



boolean
isResponseHeadersSent(Object exchange)
Are the response headers sent?



boolean
isRunning()
Is this server running (started)?



void
removeAllStaticResourcesServed()
Removes all static resources served directly by the server.



void
removeHttpAuthentication(String username)
Removes a user from all HTTP protected realms.



void
removeHttpAuthentication(String username,
                        String realmName)
Removes a user to an HTTP protected realm.



void
removeResponseHeader(Object exchange,
                    String name)
Removes a response header.



protected void
removeStaticResource(StaticResourceType staticResourceType,
                    String urlPath) 


void
removeStaticResourcesServed(StaticResourceType staticResourceType,
                           String urlPath)
Removes a static resource served directly by the server.



protected void
sendWebsocketEnpointsClosedWhenServerStops() 


void
setResponseHeader(Object exchangeObj,
                 String name,
                 List<String> values)
Sets a response header.



void
setResponseHeaders(Object exchange,
                  Map<String,List<String>> headers)
Sets the response headers.



void
setResponseStatusCode(Object exchange,
                     int statusCode)
Sets the response status code.



void
start()
Starts the server.



void
stop()
Stops the server



void
stop(boolean sendClosingMessageToPeers)
Stops the server



void
websocketCloseEndpoint(String endpointId)
Closes a Websocket endpoint.



void
websocketCloseEndpoint(String endpointId,
                      int closingCode,
                      String closingReason)
Closes the entire Websocket endpoint.



void
websocketConnection(Object exchangeObj,
                   String endpointId,
                   String peerId)
Transforms the request to a peer Websocket connection
 on the endpoint 'endpointId'.



WebsocketEndpointManager
websocketCreateEndpoint(String endpointId,
                       WebsocketEndpointHandler appEndpointHandler)
Creates a new Websocket endpoint.







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()
Description copied from interface: Server
Returns the existing HTTP authentication realms, the
 key being the realm's name and the value being the
 prefix path associated to this realm.
 
 The map is immutable.
 

Specified by:
getHttpAuthenticationRealms in interface Server








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







createUndertowTempDir
protected Path createUndertowTempDir()







isRunning
public boolean isRunning()
Description copied from interface: Server
Is this server running (started)?

Specified by:
isRunning in interface Server








start
public void start()
Description copied from interface: Server
Starts the server.

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)
Description copied from interface: Server
Creates HTTP authentication protection (realm) for the
 specified path prefix.

Specified by:
createHttpAuthenticationRealm in interface Server
realmName - The name of the realm. Must be unique on this server,
 otherwise an exception is thrown. This allows the application to add
 user to the realm using its name.








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)
Description copied from interface: Server
Adds a user to an HTTP protected realm.

Specified by:
addHttpAuthentication in interface Server








removeHttpAuthentication
public void removeHttpAuthentication(String username,
                                     String realmName)
Description copied from interface: Server
Removes a user to an HTTP protected realm.

Specified by:
removeHttpAuthentication in interface Server








removeHttpAuthentication
public void removeHttpAuthentication(String username)
Description copied from interface: Server
Removes a user from all HTTP protected realms.

Specified by:
removeHttpAuthentication in interface Server








getSpincastFrontControllerHandler
protected io.undertow.server.HttpHandler getSpincastFrontControllerHandler()







stop
public void stop()
Description copied from interface: Server
Stops the server
 
 Will try to send a "closing" message to any
 WebSocket peer before closing their connections.
 

Specified by:
stop in interface Server








stop
public void stop(boolean sendClosingMessageToPeers)
Description copied from interface: Server
Stops the server

Specified by:
stop in interface Server
Parameters:
sendClosingMessageToPeers - if true,
 Spincast will try to send a "closing" message to any 
 WebSocket peer before closing their connections.








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)
Description copied from interface: Server
Adds a static resource to serve directly by the server.

Specified by:
addStaticResourceToServe in interface Server








removeStaticResourcesServed
public void removeStaticResourcesServed(StaticResourceType staticResourceType,
                                        String urlPath)
Description copied from interface: Server
Removes a static resource served directly by the server.

Specified by:
removeStaticResourcesServed in interface Server








removeAllStaticResourcesServed
public void removeAllStaticResourcesServed()
Description copied from interface: Server
Removes all static resources served directly by the server.

Specified by:
removeAllStaticResourcesServed in interface Server








removeStaticResource
protected void removeStaticResource(StaticResourceType staticResourceType,
                                    String urlPath)







getStaticResourceServed
public StaticResource<?> getStaticResourceServed(String urlPath)
Description copied from interface: Server
Gets a static resource served directly by the server, using its path.

Specified by:
getStaticResourceServed in interface Server








getStaticResourcesServed
public Set<StaticResource<?>> getStaticResourcesServed()
Description copied from interface: Server
Gets all static resource served directly by the server.

Specified by:
getStaticResourcesServed in interface Server








getHttpMethod
public HttpMethod getHttpMethod(Object exchange)
Description copied from interface: Server
Gets the HTTP method associated with the request.

Specified by:
getHttpMethod in interface Server








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







getContentTypeBestMatch
public ContentTypeDefaults getContentTypeBestMatch(Object exchangeObj)
Description copied from interface: Server
Gets the best Content-Type to use for the current request.

Specified by:
getContentTypeBestMatch in interface Server








getFullUrlProxied
public String getFullUrlProxied(Object exchangeObj)
Description copied from interface: Server
The full encoded URL of the potentially proxied request, including the queryString. 
 Cache buster codes are removed, if there were any.
 
 Is a reverse proxy is used (such as Nginx or Apache), this is going to be the
 proxied URL, as forwarded by the reverse proxy. If no reverse proxy is used,
 this is going to be the original URL, as seen by the user.
 
 
 Even if the request is forwarded elsewhere in the framework, this
 URL won't change, it will still be the original one.
 

Specified by:
getFullUrlProxied in interface Server








getFullUrlProxied
public String getFullUrlProxied(Object exchangeObj,
                                boolean keepCacheBusters)
Description copied from interface: Server
The full encoded URL of the potentially proxied request, including the queryString. 
 
 Is a reverse proxy is used (such as Nginx or Apache), this is going to be the
 proxied URL, as forwarded by the reverse proxy. If no reverse proxy is used,
 this is going to be the original URL, as seen by the user.
 
 
 Even if the request is forwarded elsewhere in the framework, this
 URL won't change, it will still be the original one.
 

Specified by:
getFullUrlProxied in interface Server
keepCacheBusters - if true, the returned URL will contain
 the cache buster codes, if there were any. The default behavior is to 
 automatically remove them.








getFullUrlOriginal
public String getFullUrlOriginal(Object exchangeObj)
Description copied from interface: Server
The full encoded URL of the original, non proxied, request, including the queryString. 
 Cache buster codes are removed, if there were any.
 
 This is going to be the *original* URL, as seen by the user, even if 
 a reverse proxy is used (such as Nginx or Apache).
 
 
 Even if the request is forwarded elsewhere in the framework, this
 URL won't change, it will still be the original one.
 

Specified by:
getFullUrlOriginal in interface Server








getFullUrlOriginal
public String getFullUrlOriginal(Object exchangeObj,
                                 boolean keepCacheBusters)
Description copied from interface: Server
The full encoded URL of the original, non proxied, request, including the queryString. 
 
 This is going to be the *original* URL, as seen by the user, even if 
 a reverse proxy is used (such as Nginx or Apache).
 
 
 Even if the request is forwarded elsewhere in the framework, this
 URL won't change, it will still be the original one.
 

Specified by:
getFullUrlOriginal in interface Server
keepCacheBusters - if true, the returned URL will contain
 the cache buster codes, if there were any. The default behavior is to 
 automatically remove them.








setResponseHeader
public void setResponseHeader(Object exchangeObj,
                              String name,
                              List<String> values)
Description copied from interface: Server
Sets a response header. Override any existing one with the same name.

Specified by:
setResponseHeader in interface Server








setResponseHeaders
public void setResponseHeaders(Object exchange,
                               Map<String,List<String>> headers)
Description copied from interface: Server
Sets the response headers. Override any existing ones.

Specified by:
setResponseHeaders in interface Server








getResponseHeaders
public Map<String,List<String>> getResponseHeaders(Object exchangeObj)
Description copied from interface: Server
Gets the response headers.

Specified by:
getResponseHeaders in interface Server








removeResponseHeader
public void removeResponseHeader(Object exchange,
                                 String name)
Description copied from interface: Server
Removes a response header.

Specified by:
removeResponseHeader in interface Server








setResponseStatusCode
public void setResponseStatusCode(Object exchange,
                                  int statusCode)
Description copied from interface: Server
Sets the response status code.

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)
Description copied from interface: Server
Flushes some bytes to the response.

Specified by:
flushBytes in interface Server
end - if true, the exchange will be closed
 and nothing more can be send.








end
public void end(Object exchange)
Description copied from interface: Server
Ends the exchange. Nothing more can be send.

Specified by:
end in interface Server








isResponseClosed
public boolean isResponseClosed(Object exchange)
Description copied from interface: Server
Is the response closed?

Specified by:
isResponseClosed in interface Server








isResponseHeadersSent
public boolean isResponseHeadersSent(Object exchange)
Description copied from interface: Server
Are the response headers sent?

Specified by:
isResponseHeadersSent in interface Server








getRequestScheme
public String getRequestScheme(Object exchange)
Description copied from interface: Server
Gets the request scheme, "http" for example.

Specified by:
getRequestScheme in interface Server








addCookies
public void addCookies(Object exchange,
                       Map<String,Cookie> cookies)
Description copied from interface: Server
Adds cookies.

Specified by:
addCookies in interface Server








getCookies
public Map<String,String> getCookies(Object exchange)
Description copied from interface: Server
Gets the request cookies values.

Specified by:
getCookies in interface Server








getCookieEncoding
protected String getCookieEncoding()







getQueryStringParams
public Map<String,List<String>> getQueryStringParams(Object exchange)
Description copied from interface: Server
Gets the queryString parameters.

Specified by:
getQueryStringParams in interface Server








getRawInputStream
public InputStream getRawInputStream(Object exchangeObj)
Description copied from interface: Server
The raw InputStream of the current request.

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)
Description copied from interface: Server
The form data, if any.

Specified by:
getFormData in interface Server








getUploadedFiles
public Map<String,List<UploadedFile>> getUploadedFiles(Object exchangeObj)
Description copied from interface: Server
The uploaded files, if any.
 The key of the map if the HTML's name attribute.

Specified by:
getUploadedFiles in interface Server








forceRequestSizeValidation
public boolean forceRequestSizeValidation(Object exchangeObj)
Description copied from interface: Server
Is the request size valid?

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)
Description copied from interface: Server
Creates a new Websocket endpoint.

Specified by:
websocketCreateEndpoint in interface Server
Returns:
the manager for this endpoint.








createUndertowWebsocketEndpointHandler
protected WebsocketEndpointHandler createUndertowWebsocketEndpointHandler(String endpointId,
                                                                          WebsocketEndpointHandler appHandler)







websocketCloseEndpoint
public void websocketCloseEndpoint(String endpointId)
Description copied from interface: Server
Closes a Websocket endpoint. No more connections will
 be accepter

Specified by:
websocketCloseEndpoint in interface Server








websocketCloseEndpoint
public void websocketCloseEndpoint(String endpointId,
                                   int closingCode,
                                   String closingReason)
Description copied from interface: Server
Closes the entire Websocket endpoint. 
 All peer connections of this endpoint will be
 closed.

Specified by:
websocketCloseEndpoint in interface Server
closingCode - The closing code.
closingReason - The closing reason.








websocketConnection
public void websocketConnection(Object exchangeObj,
                                String endpointId,
                                String peerId)
Description copied from interface: Server
Transforms the request to a peer Websocket connection
 on the endpoint 'endpointId'.

Specified by:
websocketConnection in interface Server








getWebsocketEndpointManagers
public List<WebsocketEndpointManager> getWebsocketEndpointManagers()
Description copied from interface: Server
Returns the managers of the existing Websockets endpoints.

Specified by:
getWebsocketEndpointManagers in interface Server








getWebsocketEndpointManager
public WebsocketEndpointManager getWebsocketEndpointManager(String endpointId)
Description copied from interface: Server
Returns the manager for a Websockets endpoint.

Specified by:
getWebsocketEndpointManager in interface Server
Returns:
the manager or null if not found.








getIp
public String getIp(Object exchangeObj)
Description copied from interface: Server
Gets the IP of the current request.

Specified by:
getIp in interface Server














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

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

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)` Adds cookies.
`void`	`addHttpAuthentication(String realmName, String username, String password)` Adds a user to an HTTP protected realm.
`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)` Adds a static resource to serve directly by the server.
`protected io.undertow.server.HttpServerExchange`	`castExchange(Object exchange)`
`void`	`createHttpAuthenticationRealm(String pathPrefix, String realmName)` Creates HTTP authentication protection (realm) for the specified path prefix.
`protected Path`	`createUndertowTempDir()`
`protected WebsocketEndpointHandler`	`createUndertowWebsocketEndpointHandler(String endpointId, WebsocketEndpointHandler appHandler)`
`void`	`end(Object exchange)` Ends the exchange.
`void`	`flushBytes(Object exchange, byte[] bytes, boolean end)` Flushes some bytes to the response.
`boolean`	`forceRequestSizeValidation(Object exchangeObj)` Is the request size valid?
`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)` Gets the best `Content-Type` to use for the current request.
`protected String`	`getCookieEncoding()`
`protected CookieFactory`	`getCookieFactory()`
`Map<String,String>`	`getCookies(Object exchange)` Gets the request cookies values.
`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)` The form data, if any.
`protected io.undertow.server.handlers.form.FormParserFactory`	`getFormParserFactory()`
`protected FrontController`	`getFrontController()`
`String`	`getFullUrlOriginal(Object exchangeObj)` The full encoded URL of the original, non proxied, request, including the queryString.
`String`	`getFullUrlOriginal(Object exchangeObj, boolean keepCacheBusters)` The full encoded URL of the original, non proxied, request, including the queryString.
`String`	`getFullUrlProxied(Object exchangeObj)` The full encoded URL of the potentially proxied request, including the queryString.
`String`	`getFullUrlProxied(Object exchangeObj, boolean keepCacheBusters)` The full encoded URL of the potentially proxied request, including the queryString.
`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()` Returns the existing HTTP authentication realms, the key being the realm's name and the value being the prefix path associated to this realm.
`protected io.undertow.server.HttpHandler`	`getHttpAuthHandlerNextHandler()`
`protected Map<String,SpincastHttpAuthIdentityManager>`	`getHttpAuthIdentityManagersByRealmName()`
`HttpMethod`	`getHttpMethod(Object exchange)` Gets the HTTP method associated with the request.
`String`	`getIp(Object exchangeObj)` Gets the IP of the current request.
`protected int`	`getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()`
`protected SpincastHttpAuthIdentityManager`	`getOrCreateHttpAuthIdentityManagersByRealmName(String realmName)`
`Map<String,List<String>>`	`getQueryStringParams(Object exchange)` Gets the queryString parameters.
`InputStream`	`getRawInputStream(Object exchangeObj)` The raw InputStream of the current request.
`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)` Gets the request scheme, "http" for example.
`Map<String,List<String>>`	`getResponseHeaders(Object exchangeObj)` Gets the response headers.
`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)` Gets a static resource served directly by the server, using its path.
`protected io.undertow.server.handlers.PathHandler`	`getStaticResourcesPathHandler()`
`Set<StaticResource<?>>`	`getStaticResourcesServed()` Gets all static resource served directly by the server.
`protected Map<String,StaticResource<?>>`	`getStaticResourcesServedByUrlPath()`
`Map<String,List<UploadedFile>>`	`getUploadedFiles(Object exchangeObj)` The uploaded files, if any.
`protected Object`	`getWebsocketEndpointCreationLock(String endpointId)` Gets the creation/close lock for a specific Websocket endpoint.
`WebsocketEndpointManager`	`getWebsocketEndpointManager(String endpointId)` Returns the manager for a Websockets endpoint.
`List<WebsocketEndpointManager>`	`getWebsocketEndpointManagers()` Returns the managers of the existing Websockets endpoints.
`protected Map<String,WebsocketEndpoint>`	`getWebsocketEndpointsMap()`
`boolean`	`isResponseClosed(Object exchange)` Is the response closed?
`boolean`	`isResponseHeadersSent(Object exchange)` Are the response headers sent?
`boolean`	`isRunning()` Is this server running (started)?
`void`	`removeAllStaticResourcesServed()` Removes all static resources served directly by the server.
`void`	`removeHttpAuthentication(String username)` Removes a user from all HTTP protected realms.
`void`	`removeHttpAuthentication(String username, String realmName)` Removes a user to an HTTP protected realm.
`void`	`removeResponseHeader(Object exchange, String name)` Removes a response header.
`protected void`	`removeStaticResource(StaticResourceType staticResourceType, String urlPath)`
`void`	`removeStaticResourcesServed(StaticResourceType staticResourceType, String urlPath)` Removes a static resource served directly by the server.
`protected void`	`sendWebsocketEnpointsClosedWhenServerStops()`
`void`	`setResponseHeader(Object exchangeObj, String name, List<String> values)` Sets a response header.
`void`	`setResponseHeaders(Object exchange, Map<String,List<String>> headers)` Sets the response headers.
`void`	`setResponseStatusCode(Object exchange, int statusCode)` Sets the response status code.
`void`	`start()` Starts the server.
`void`	`stop()` Stops the server
`void`	`stop(boolean sendClosingMessageToPeers)` Stops the server
`void`	`websocketCloseEndpoint(String endpointId)` Closes a Websocket endpoint.
`void`	`websocketCloseEndpoint(String endpointId, int closingCode, String closingReason)` Closes the entire Websocket endpoint.
`void`	`websocketConnection(Object exchangeObj, String endpointId, String peerId)` Transforms the request to a peer Websocket connection on the endpoint 'endpointId'.
`WebsocketEndpointManager`	`websocketCreateEndpoint(String endpointId, WebsocketEndpointHandler appEndpointHandler)` Creates a new Websocket endpoint.