Server (org.spincast:spincast-framework 0.9.31 API)

All Known Implementing Classes:

SpincastUndertowServer
```
public interface Server
```
The interface a HTTP server implementation must implement.
The "exchange" object is a request scoped object provided by the HTTP server to identify the request.

A Server implementation has to receive FrontController as a dependency and call handle(...) on it when a new request is made.

Note that the server will automatically remove any cache buster codes from the request's path.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`void`	`addStaticResourceToServe(StaticResource<?> staticResource)` Adds a static resource to serve directly by the server.
`void`	`createHttpAuthenticationRealm(String pathPrefix, String realmName)` Creates HTTP authentication protection (realm) for the specified path prefix.
`void`	`end(Object exchange)` Ends the exchange.
`void`	`flushBytes(Object exchange, byte[] bytes, boolean end)` Flushes some bytes to the response.
`boolean`	`forceRequestSizeValidation(Object exchange)` Is the request size valid?
`ContentTypeDefaults`	`getContentTypeBestMatch(Object exchange)` Gets the best `Content-Type` to use for the current request.
`Map<String,Cookie>`	`getCookies(Object exchange)` Gets the current cookies.
`Map<String,List<String>>`	`getFormData(Object exchange)` The form data, if any.
`String`	`getFullUrlOriginal(Object exchange)` The full encoded URL of the original, non proxied, request, including the queryString.
`String`	`getFullUrlOriginal(Object exchange, boolean keepCacheBusters)` The full encoded URL of the original, non proxied, request, including the queryString.
`String`	`getFullUrlProxied(Object exchange)` The full encoded URL of the potentially proxied request, including the queryString.
`String`	`getFullUrlProxied(Object exchange, boolean keepCacheBusters)` The full encoded URL of the potentially proxied request, including the queryString.
`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.
`HttpMethod`	`getHttpMethod(Object exchange)` Gets the HTTP method associated with the request.
`Map<String,List<String>>`	`getQueryStringParams(Object exchange)` Gets the queryString parameters.
`InputStream`	`getRawInputStream(Object exchange)` The raw InputStream of the current request.
`Map<String,List<String>>`	`getRequestHeaders(Object exchange)` The headers from the request.
`String`	`getRequestScheme(Object exchange)` Gets the request scheme, "http" for example.
`Map<String,List<String>>`	`getResponseHeaders(Object exchange)` Gets the response headers.
`StaticResource<?>`	`getStaticResourceServed(String urlPath)` Gets a static resource served directly by the server, using its path.
`Set<StaticResource<?>>`	`getStaticResourcesServed()` Gets all static resource served directly by the server.
`Map<String,List<File>>`	`getUploadedFiles(Object exchange)` The uploaded files, if any.
`WebsocketEndpointManager`	`getWebsocketEndpointManager(String endpointId)` Returns the manager for a Websockets endpoint.
`List<WebsocketEndpointManager>`	`getWebsocketEndpointManagers()` Returns the managers of the existing Websockets endpoints.
`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.
`void`	`removeStaticResourcesServed(StaticResourceType staticResourceType, String urlPath)` Removes a static resource served directly by the server.
`void`	`setResponseHeader(Object exchange, 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 exchange, String endpointId, String peerId)` Transforms the request to a peer Websocket connection on the endpoint 'endpointId'.
`WebsocketEndpointManager`	`websocketCreateEndpoint(String endpointId, WebsocketEndpointHandler endpointHandler)` Creates a new Websocket endpoint.

- Method Detail
  - start
```
void start()
```
    Starts the server.
  - stop
```
void stop()
```
    Stops the server
    Will try to send a "closing" message to any WebSocket peer before closing their connections.
  - stop
```
void stop(boolean sendClosingMessageToPeers)
```
    Stops the server
    
    Parameters:
    
    sendClosingMessageToPeers - if true, Spincast will try to send a "closing" message to any WebSocket peer before closing their connections.
  - isRunning
```
boolean isRunning()
```
    Is this server running (started)?
  - addStaticResourceToServe
```
void addStaticResourceToServe(StaticResource<?> staticResource)
```
    Adds a static resource to serve directly by the server.
  - removeStaticResourcesServed
```
void removeStaticResourcesServed(StaticResourceType staticResourceType,
                                 String urlPath)
```
    Removes a static resource served directly by the server.
  - removeAllStaticResourcesServed
```
void removeAllStaticResourcesServed()
```
    Removes all static resources served directly by the server.
  - getStaticResourceServed
```
StaticResource<?> getStaticResourceServed(String urlPath)
```
    Gets a static resource served directly by the server, using its path.
  - getStaticResourcesServed
```
Set<StaticResource<?>> getStaticResourcesServed()
```
    Gets all static resource served directly by the server.
  - getHttpMethod
```
HttpMethod getHttpMethod(Object exchange)
```
    Gets the HTTP method associated with the request.
  - getFullUrlOriginal
```
String getFullUrlOriginal(Object exchange)
```
    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.
  - getFullUrlOriginal
```
String getFullUrlOriginal(Object exchange,
                          boolean keepCacheBusters)
```
    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.
    
    Parameters:
    
    keepCacheBusters - if true, the returned URL will contain the cache buster codes, if there were any. The default behavior is to automatically remove them.
  - getFullUrlProxied
```
String getFullUrlProxied(Object exchange)
```
    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.
  - getFullUrlProxied
```
String getFullUrlProxied(Object exchange,
                         boolean keepCacheBusters)
```
    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.
    
    Parameters:
    
    keepCacheBusters - if true, the returned URL will contain the cache buster codes, if there were any. The default behavior is to automatically remove them.
  - getContentTypeBestMatch
```
ContentTypeDefaults getContentTypeBestMatch(Object exchange)
```
    Gets the best Content-Type to use for the current request.
  - setResponseHeaders
```
void setResponseHeaders(Object exchange,
                        Map<String,List<String>> headers)
```
    Sets the response headers. Override any existing ones.
  - setResponseHeader
```
void setResponseHeader(Object exchange,
                       String name,
                       List<String> values)
```
    Sets a response header. Override any existing one with the same name.
  - getResponseHeaders
```
Map<String,List<String>> getResponseHeaders(Object exchange)
```
    Gets the response headers.
  - removeResponseHeader
```
void removeResponseHeader(Object exchange,
                          String name)
```
    Removes a response header.
  - addCookies
```
void addCookies(Object exchange,
                Map<String,Cookie> cookies)
```
    Adds cookies.
  - getCookies
```
Map<String,Cookie> getCookies(Object exchange)
```
    Gets the current cookies.
  - getQueryStringParams
```
Map<String,List<String>> getQueryStringParams(Object exchange)
```
    Gets the queryString parameters.
  - setResponseStatusCode
```
void setResponseStatusCode(Object exchange,
                           int statusCode)
```
    Sets the response status code.
  - flushBytes
```
void flushBytes(Object exchange,
                byte[] bytes,
                boolean end)
```
    Flushes some bytes to the response.
    
    Parameters:
    
    end - if true, the exchange will be closed and nothing more can be send.
  - end
```
void end(Object exchange)
```
    Ends the exchange. Nothing more can be send.
  - isResponseClosed
```
boolean isResponseClosed(Object exchange)
```
    Is the response closed?
  - isResponseHeadersSent
```
boolean isResponseHeadersSent(Object exchange)
```
    Are the response headers sent?
  - getRequestScheme
```
String getRequestScheme(Object exchange)
```
    Gets the request scheme, "http" for example.
  - getRawInputStream
```
InputStream getRawInputStream(Object exchange)
```
    The raw InputStream of the current request.
  - getFormData
```
Map<String,List<String>> getFormData(Object exchange)
```
    The form data, if any.
  - getUploadedFiles
```
Map<String,List<File>> getUploadedFiles(Object exchange)
```
    The uploaded files, if any.
  - forceRequestSizeValidation
```
boolean forceRequestSizeValidation(Object exchange)
```
    Is the request size valid?
  - getRequestHeaders
```
Map<String,List<String>> getRequestHeaders(Object exchange)
```
    The headers from the request. The names are all lowercased.
  - createHttpAuthenticationRealm
```
void createHttpAuthenticationRealm(String pathPrefix,
                                   String realmName)
```
    Creates HTTP authentication protection (realm) for the specified path prefix.
    
    Parameters:
    
    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.
  - getHttpAuthenticationRealms
```
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.
    The map is immutable.
  - addHttpAuthentication
```
void addHttpAuthentication(String realmName,
                           String username,
                           String password)
```
    Adds a user to an HTTP protected realm.
  - removeHttpAuthentication
```
void removeHttpAuthentication(String username,
                              String realmName)
```
    Removes a user to an HTTP protected realm.
  - removeHttpAuthentication
```
void removeHttpAuthentication(String username)
```
    Removes a user from all HTTP protected realms.
  - websocketCreateEndpoint
```
WebsocketEndpointManager websocketCreateEndpoint(String endpointId,
                                                 WebsocketEndpointHandler endpointHandler)
```
    Creates a new Websocket endpoint.
    
    Returns:
    
    the manager for this endpoint.
  - websocketCloseEndpoint
```
void websocketCloseEndpoint(String endpointId)
```
    Closes a Websocket endpoint. No more connections will be accepter
  - websocketCloseEndpoint
```
void websocketCloseEndpoint(String endpointId,
                            int closingCode,
                            String closingReason)
```
    Closes the entire Websocket endpoint. All peer connections of this endpoint will be closed.
    
    Parameters:
    
    closingCode - The closing code.
    
    closingReason - The closing reason.
  - websocketConnection
```
void websocketConnection(Object exchange,
                         String endpointId,
                         String peerId)
```
    Transforms the request to a peer Websocket connection on the endpoint 'endpointId'.
  - getWebsocketEndpointManagers
```
List<WebsocketEndpointManager> getWebsocketEndpointManagers()
```
    Returns the managers of the existing Websockets endpoints.
  - getWebsocketEndpointManager
```
WebsocketEndpointManager getWebsocketEndpointManager(String endpointId)
```
    Returns the manager for a Websockets endpoint.
    
    Returns:
    
    the manager or null if not found.

Interface Server

Method Summary

Method Detail

start

stop

stop

isRunning

addStaticResourceToServe

removeStaticResourcesServed

removeAllStaticResourcesServed

getStaticResourceServed

getStaticResourcesServed

getHttpMethod

getFullUrlOriginal

getFullUrlOriginal

getFullUrlProxied

getFullUrlProxied

getContentTypeBestMatch

setResponseHeaders

setResponseHeader

getResponseHeaders

removeResponseHeader

addCookies

getCookies

getQueryStringParams

setResponseStatusCode

flushBytes

end

isResponseClosed

isResponseHeadersSent

getRequestScheme

getRawInputStream

getFormData

getUploadedFiles

forceRequestSizeValidation

getRequestHeaders

createHttpAuthenticationRealm

getHttpAuthenticationRealms

addHttpAuthentication

removeHttpAuthentication

removeHttpAuthentication

websocketCreateEndpoint

websocketCloseEndpoint

websocketCloseEndpoint

websocketConnection

getWebsocketEndpointManagers

getWebsocketEndpointManager