org.spincast.core.server

Interface IServer

All Known Implementing Classes:

SpincastUndertowServer

public interface IServer

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 IServer implementation has to receive IFrontController as a dependency and call handle(...) on it when a new request is made.

Method Summary

Modifier and Type	Method and Description
void	addCookies(Object exchange, Map<String,ICookie> cookies) Adds cookies.
void	addHttpAuthentication(String realmName, String username, String password) Adds a user to an HTTP protected realm.
void	addStaticResourceToServe(IStaticResource<?> 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,ICookie>	getCookies(Object exchange) Gets the current cookies.
Map<String,List<String>>	getFormDatas(Object exchange) The form datas, if any.
String	getFullUrl(Object exchange) The full encoded URL of the original 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.
IStaticResource<?>	getStaticResourceServed(String urlPath) Gets a static resource served directly by the server, using its path.
Set<IStaticResource<?>>	getStaticResourcesServed() Gets all static resource served directly by the server.
Map<String,List<File>>	getUploadedFiles(Object exchange) The uploaded files, if any.
IWebsocketEndpointManager	getWebsocketEndpointManager(String endpointId) Returns the manager for a Websockets endpoint.
List<IWebsocketEndpointManager>	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?
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	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'.
IWebsocketEndpointManager	websocketCreateEndpoint(String endpointId, IWebsocketEndpointHandler endpointHandler) Creates a new Websocket endpoint.

Method Detail

start

void start()

Starts the server.

stop

void stop()

Stops the server

addStaticResourceToServe

void addStaticResourceToServe(IStaticResource<?> 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

IStaticResource<?> getStaticResourceServed(String urlPath)

Gets a static resource served directly by the server, using its path.

getStaticResourcesServed

Set<IStaticResource<?>> getStaticResourcesServed()

Gets all static resource served directly by the server.

getHttpMethod

HttpMethod getHttpMethod(Object exchange)

Gets the HTTP method associated with the request.

getFullUrl

String getFullUrl(Object exchange)

The full encoded URL of the original request, including the queryString. Even if the request is forwarded elsewhere in the framework, this URL won't change, it will still be the original one.

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,ICookie> cookies)

Adds cookies.

getCookies

Map<String,ICookie> 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.

getFormDatas

Map<String,List<String>> getFormDatas(Object exchange)

The form datas, 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

IWebsocketEndpointManager websocketCreateEndpoint(String endpointId,
                                                  IWebsocketEndpointHandler 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<IWebsocketEndpointManager> getWebsocketEndpointManagers()

Returns the managers of the existing Websockets endpoints.

getWebsocketEndpointManager

IWebsocketEndpointManager getWebsocketEndpointManager(String endpointId)

Returns the manager for a Websockets endpoint.

Returns:

the manager or null if not found.