Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W X Z 

A

accept(ContentTypeDefaults...) - Method in interface org.spincast.core.routing.IRouteBuilder
Sets the accepted Content-Types.
accept(Set<ContentTypeDefaults>) - Method in interface org.spincast.core.routing.IRouteBuilder
Sets the accepted Content-Types.
acceptAsString(String...) - Method in interface org.spincast.core.routing.IRouteBuilder
Sets the accepted Content-Types.
acceptAsString(Set<String>) - Method in interface org.spincast.core.routing.IRouteBuilder
Sets the accepted Content-Types.
add(String, Object) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Adds a request scoped variable.
add(Map<String, Object>) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Adds request scoped variables.
add(Object) - Method in interface org.spincast.core.json.IJsonArray
Adds an element at the end.
add(Object) - Method in class org.spincast.core.json.JsonArray
 
addCookie(ICookie) - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Adds a cookie.
addCookie(String, String) - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Adds a cookie using the specified name and value.
addCookie(String, String, String, String, Date, boolean, boolean, boolean, int) - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Adds a cookie, using all possible configurations.
addCookies(Object, Map<String, ICookie>) - Method in interface org.spincast.core.server.IServer
Adds cookies.
addDefaultGlobalTemplateVariables(R) - Method in interface org.spincast.core.filters.ISpincastFilters
Adds some default variables so they are available by default to the templating engine (in a request scope).
addDefaultGlobalTemplateVariables(R) - Method in class org.spincast.core.filters.SpincastFilters
 
addDefaultNotFoundRoute() - Method in class org.spincast.core.controllers.SpincastFrontController
Add the default Not Found route.
addDependenciesInCustomRequestScope(R) - Method in class org.spincast.core.controllers.SpincastFrontController
Add dependencies to the custom request scope
addEndpointController(String, IWebsocketController<?, ?>) - Method in interface org.spincast.core.websocket.IWebsocketEndpointToControllerManager
Adds a link between a WebSocket endpoint and a controller.
addEndpointController(String, IWebsocketController<?, ?>) - Method in class org.spincast.core.websocket.WebsocketEndpointToControllerManager
 
addFirst(Object) - Method in interface org.spincast.core.json.IJsonArray
Adds an element at the beginning.
addFirst(Object) - Method in class org.spincast.core.json.JsonArray
 
addHeaderValue(String, String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Adds a value to a response header.
addHeaderValue(String, String) - Method in interface org.spincast.core.filters.ICorsFilterClient
Adds an header value.
addHeaderValues(String, List<String>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Adds a list of values to a response header.
addHttpAuthentication(String, String, String) - Method in interface org.spincast.core.server.IServer
Adds a user to an HTTP protected realm.
addRequestContextInCustomRequestScope(R) - Method in class org.spincast.core.controllers.SpincastFrontController
Add the request context object in the cutom request scope
addRoute(IRoute<R>) - Method in interface org.spincast.core.routing.IRouter
Adds a route, directly.
addRouteParamPatternAlias(String, String) - Method in interface org.spincast.core.routing.IRouter
Adds an alias for a path pattern.
addSecurityHeaders(R) - Method in interface org.spincast.core.filters.ISpincastFilters
Adds some recommended security headers.
addSecurityHeaders(R) - Method in class org.spincast.core.filters.SpincastFilters
 
addStaticResource(IStaticResource<R>) - Method in interface org.spincast.core.routing.IRouter
Adds a static resource route, directly.
addStaticResourceToServe(IStaticResource<?>) - Method in interface org.spincast.core.server.IServer
Adds a static resource to serve directly by the server.
addTemplatingGlobalVariable(String, Object) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Adds a global variable that will be available to any following evaluation by the templating engine.
addTemplatingGlobalVariables(Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Adds global variables that will be available to any following evaluation by the templating engine.
addWebsocketRoute(IWebsocketRoute<R, W>) - Method in interface org.spincast.core.routing.IRouter
Adds a Websocket route, directly.
after(IHandler<R>) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds an "after" filter which will only be applied to this particular route.
after() - Method in interface org.spincast.core.routing.IRouter
Creates an "after" filter.
after(String) - Method in interface org.spincast.core.routing.IRouter
Creates an "after" filter.
ALL() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds all HTTP methods as being supported.
ALL(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a route matching any HTTP method.
allRoutingTypes() - Method in interface org.spincast.core.routing.IRouteBuilder
This route will be considered for all routing types.
apply(ICorsFilterClient) - Method in class org.spincast.core.filters.CorsFilter
 
apply(ICorsFilterClient) - Method in interface org.spincast.core.filters.ICorsFilter
Apply the cors filter and return the result.

B

before(IHandler<R>) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds a "before" filter which will only be applied to this particular route.
before() - Method in interface org.spincast.core.routing.IRouter
Creates a "before" filter.
before(String) - Method in interface org.spincast.core.routing.IRouter
Creates a "before" filter.
before(IHandler<R>) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilder
Adds a before filter.
beforeAndAfter() - Method in interface org.spincast.core.routing.IRouter
Creates a "before" and an "after" filters.
beforeAndAfter(String) - Method in interface org.spincast.core.routing.IRouter
Creates a "before" and an "after" filters.
bindAlphaAlias(boolean, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
bindAlphaNumericAlias(boolean, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
bindAlphaNumericPlusAlias(boolean, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
bindAlphaPlusAlias(boolean, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
bindDefaultPredefinedRouteParamPatternsBinder() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindFrontController() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindJsonObjectFactory() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindMainArgs() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindNumericAlias(boolean, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
bindNumericPlusAlias(boolean, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
bindRequestContextBaseDeps() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindRequestContextFactory() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindRequestContextInRequestScope() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindRequestContextType() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindSpincastFilters() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindSpincastRequestScope() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindSpincastUtilsClass() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindSSLContextFactory() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindWebsocketContextFactory() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindWebsocketContextType() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindWebsocketEndpointHandlerFactory() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
bindWebsocketEndpointToControllerManager() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
Bool - Class in org.spincast.core.utils
Boolean object that can't be autoboxed.

C

cache(int) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
The number of seconds the client should cache this resource before requesting it again.
cache(int, boolean) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
The number of seconds the client should cache this resource before requesting it again.
cache(int, boolean, Integer) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
The number of seconds the client should cache this resource before requesting it again.
cache(R) - Method in interface org.spincast.core.filters.ISpincastFilters
 
cache(R, int) - Method in interface org.spincast.core.filters.ISpincastFilters
 
cache(R, int, boolean) - Method in interface org.spincast.core.filters.ISpincastFilters
 
cache(R, int, boolean, Integer) - Method in interface org.spincast.core.filters.ISpincastFilters
 
cache(R) - Method in class org.spincast.core.filters.SpincastFilters
 
cache(R, int) - Method in class org.spincast.core.filters.SpincastFilters
 
cache(R, int, boolean) - Method in class org.spincast.core.filters.SpincastFilters
 
cache(R, int, boolean, Integer) - Method in class org.spincast.core.filters.SpincastFilters
 
cache() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds cache headers.
cache(int) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds public cache headers.
cache(int, boolean) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds cache headers.
cache(int, boolean, Integer) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds cache headers.
cache(int) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Adds public cache headers.
cache(int, boolean) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Adds cache headers.
cache(int, boolean, Integer) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Adds cache headers.
cacheHeaders() - Method in interface org.spincast.core.exchange.IRequestContext
Cache headers related methods.
cacheHeaders() - Method in class org.spincast.core.exchange.RequestContextBase
 
callRouteHandlers(R, IRoutingResult<R>) - Method in class org.spincast.core.controllers.SpincastFrontController
Call the handlers, in order they are specified.
classpath(String) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
The path to the resource, on the classpath.
clear() - Method in interface org.spincast.core.json.IJsonArray
Clears all elements.
clear() - Method in class org.spincast.core.json.JsonArray
 
closeConnection() - Method in interface org.spincast.core.websocket.IWebsocketPeerManager
Closes the connection with the peer.
closeConnectionWithCurrentPeer() - Method in interface org.spincast.core.websocket.IWebsocketContext
Closes the connection with the current peer.
closeConnectionWithCurrentPeer() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
closeEndpoint() - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Closes the entire WebSocket endpoint.
closeEndpoint(boolean) - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Closes the entire WebSocket endpoint.
closeEndpoint(int, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Closes the entire WebSocket endpoint.
closeEndpoint(int, String, boolean) - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Closes the entire WebSocket endpoint.
closePeer(String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Closes a specific peer connection on the endpoint.
closePeer(String, int, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Closes a specific peer connection on the endpoint.
configure() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
ContentTypeDefaults - Enum in org.spincast.core.utils
Some often used Content-Types.
COOKIE_NAME_LOCALE_TO_USE - Static variable in class org.spincast.core.config.SpincastConstants
Name of the Cookie to save the user Locale.
cookies() - Method in interface org.spincast.core.exchange.IRequestContext
Cookies related methods.
cookies() - Method in class org.spincast.core.exchange.RequestContextBase
 
cors(R) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R, Set<String>) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R, Set<String>, Set<String>) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R, Set<String>, Set<String>, Set<String>) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R, Set<String>, Set<String>, Set<String>, boolean) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>, int) - Method in interface org.spincast.core.filters.ISpincastFilters
Cross-Origin Resource Sharing (Cors) handling.
cors(R) - Method in class org.spincast.core.filters.SpincastFilters
 
cors(R, Set<String>) - Method in class org.spincast.core.filters.SpincastFilters
 
cors(R, Set<String>, Set<String>) - Method in class org.spincast.core.filters.SpincastFilters
 
cors(R, Set<String>, Set<String>, Set<String>) - Method in class org.spincast.core.filters.SpincastFilters
 
cors(R, Set<String>, Set<String>, Set<String>, boolean) - Method in class org.spincast.core.filters.SpincastFilters
 
cors(R, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>) - Method in class org.spincast.core.filters.SpincastFilters
 
cors(R, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>, int) - Method in class org.spincast.core.filters.SpincastFilters
 
cors() - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on all matching requests (except the static resources, for whom cors has to be activated directly!)
cors(Set<String>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
cors(Set<String>, Set<String>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
cors(Set<String>, Set<String>, Set<String>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
cors(Set<String>, Set<String>, Set<String>, boolean) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
cors(Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
cors(Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>, int) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
cors(String) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on all requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors(String, Set<String>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors(String, Set<String>, Set<String>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors(String, Set<String>, Set<String>, Set<String>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors(String, Set<String>, Set<String>, Set<String>, boolean) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors(String, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors(String, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>, int) - Method in interface org.spincast.core.routing.IRouter
Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
cors() - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Enables Cross-Origin Resource Sharing (Cors)
cors(Set<String>) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Enables Cross-Origin Resource Sharing (Cors)
cors(Set<String>, Set<String>) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Enables Cross-Origin Resource Sharing (Cors)
cors(Set<String>, Set<String>, Set<String>) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Enables Cross-Origin Resource Sharing (Cors)
cors(Set<String>, Set<String>, Set<String>, boolean) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Enables Cross-Origin Resource Sharing (Cors)
cors(Set<String>, Set<String>, Set<String>, boolean, int) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Enables Cross-Origin Resource Sharing (Cors)
corsAddAllowCookies(ICorsFilterClient) - Method in class org.spincast.core.filters.CorsFilter
 
corsAddAllowMethods(ICorsFilterClient, Set<HttpMethod>) - Method in class org.spincast.core.filters.CorsFilter
 
corsAddAllowOrigin(ICorsFilterClient) - Method in class org.spincast.core.filters.CorsFilter
 
corsAddExtraHeadersAllowedToBeRead(ICorsFilterClient, Set<String>) - Method in class org.spincast.core.filters.CorsFilter
 
corsAddExtraHeadersAllowedToBeSent(ICorsFilterClient, Set<String>) - Method in class org.spincast.core.filters.CorsFilter
 
corsAddMaxAge(ICorsFilterClient, int) - Method in class org.spincast.core.filters.CorsFilter
 
corsCore(ICorsFilterClient, Set<String>, boolean) - Method in class org.spincast.core.filters.CorsFilter
 
CorsFilter - Class in org.spincast.core.filters
Cors filter implementation.
CorsFilter() - Constructor for class org.spincast.core.filters.CorsFilter
 
CorsFilterResponse - Enum in org.spincast.core.filters
A response from the cors filter.
create() - Method in interface org.spincast.core.json.IJsonManager
Creates an empty JsonObject
create(String) - Method in interface org.spincast.core.json.IJsonManager
Creates a JsonObject from a Json String.
create(InputStream) - Method in interface org.spincast.core.json.IJsonManager
Creates a JsonObject from an inputStream.
create() - Method in interface org.spincast.core.json.IJsonObjectFactory
 
create(String) - Method in interface org.spincast.core.routing.IETagFactory
Creates a strong ETag, using a specific tag.
create(String, boolean) - Method in interface org.spincast.core.routing.IETagFactory
Creates a strong or weak ETag, using a specific tag.
create(String, boolean, boolean) - Method in interface org.spincast.core.routing.IETagFactory
Creates a strong or weak ETag, using a specific tag.
create(IRouter<R, W>, String) - Method in interface org.spincast.core.routing.IRedirectRuleBuilderFactory
 
create(IHandler<R>) - Method in interface org.spincast.core.routing.IRouteBuilder
Creates and returns the route without adding it to the router.
create() - Method in interface org.spincast.core.routing.IRouteBuilderFactory
Creates a route builder without using a router.
create(IRouter<R, W>) - Method in interface org.spincast.core.routing.IRouteBuilderFactory
Creates a route builder using the specified router.
create() - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Creates and returns the static resource without adding it to the router.
create(boolean) - Method in interface org.spincast.core.routing.IStaticResourceBuilderFactory
Creates a static resources builder by specifying if the resource to build is a file or a directory, but without using a router.
create(IRouter<R, W>, boolean) - Method in interface org.spincast.core.routing.IStaticResourceBuilderFactory
Creates a static resources builder by specifying if the resource to build is a file or a directory.
create(StaticResourceType, String, String, IHandler<R>, IStaticResourceCorsConfig, IStaticResourceCacheConfig) - Method in interface org.spincast.core.routing.IStaticResourceFactory
 
create(String, String, IWebsocketPeerManager) - Method in interface org.spincast.core.websocket.IWebsocketContextFactory
 
create(String, IWebsocketController<R, W>) - Method in interface org.spincast.core.websocket.IWebsocketEndpointHandlerFactory
 
create(IWebsocketController<R, W>) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilder
Creates and returns the WebSocket route without adding it to the router.
create() - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilderFactory
Creates a route builder without using a router.
create(IRouter<R, W>) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilderFactory
Creates a WebSocket route builder using the specified router.
createArray() - Method in interface org.spincast.core.json.IJsonManager
Creates an empty JsonArray.
createArray(String) - Method in interface org.spincast.core.json.IJsonManager
Creates a JsonArray from a Json String.
createArray(InputStream) - Method in interface org.spincast.core.json.IJsonManager
Creates a JsonArray from an inputStream.
createArray() - Method in interface org.spincast.core.json.IJsonObjectFactory
 
createControllerKey(IWebsocketController<?, ?>) - Method in class org.spincast.core.websocket.WebsocketEndpointToControllerManager
 
createCookie(String) - Method in interface org.spincast.core.cookies.ICookieFactory
Creates a cookie using the given name (null value).
createCookie(String, String) - Method in interface org.spincast.core.cookies.ICookieFactory
Creates a cookie using the given name and value.
createCookie(String, String, String, String, Date, boolean, boolean, boolean, int) - Method in interface org.spincast.core.cookies.ICookieFactory
Creates a cookie using all possible configurations.
createCorsFilterClient(R, Set<String>, Set<String>, Set<String>, boolean, Set<HttpMethod>, int) - Method in class org.spincast.core.filters.SpincastFilters
Creates a client for the cors filter.
createForwardedRequestContext(R, String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
createHttpAuthenticationRealm(String, String) - Method in interface org.spincast.core.server.IServer
Creates HTTP authentication protection (realm) for the specified path prefix.
createPlaceholder(String) - Method in interface org.spincast.core.templating.ITemplatingEngine
Creates a placeholder using the current templating engine implementation.
createPlaceholder(String) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Creates a placeholder using the current templating engine implementation.
createRequestContext(Object) - Method in interface org.spincast.core.exchange.IRequestContextFactory
 
createSSLContext(String, String, String, String) - Method in interface org.spincast.core.utils.ssl.ISSLContextFactory
 
createSSLContext(String, String, String, String) - Method in class org.spincast.core.utils.ssl.SSLContextFactory
 
createSSLContext(KeyManager[], TrustManager[]) - Method in class org.spincast.core.utils.ssl.SSLContextFactory
 
createWebsocketEndpointHandler(String, IWebsocketController<R, W>) - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
createWebsocketPeerManager(String) - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
Creates a peer specific manager from the endpoint manager.
createWebsocketRouteHandler(IWebsocketRoute<R, W>) - Method in interface org.spincast.core.websocket.IWebsocketRouteHandlerFactory
 
customExceptionHandling(Throwable, R, IRoutingResult<R>) - Method in class org.spincast.core.controllers.SpincastFrontController
Custom exception handling.
CustomStatusCodeException - Exception in org.spincast.core.exceptions
 
CustomStatusCodeException() - Constructor for exception org.spincast.core.exceptions.CustomStatusCodeException
 
CustomStatusCodeException(String) - Constructor for exception org.spincast.core.exceptions.CustomStatusCodeException
 
CustomStatusCodeException(String, int) - Constructor for exception org.spincast.core.exceptions.CustomStatusCodeException
 
CustomStatusCodeException(boolean) - Constructor for exception org.spincast.core.exceptions.CustomStatusCodeException
 
CustomStatusCodeException(String, boolean) - Constructor for exception org.spincast.core.exceptions.CustomStatusCodeException
 
CustomStatusCodeException(String, int, boolean) - Constructor for exception org.spincast.core.exceptions.CustomStatusCodeException
 

D

DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_CACHE_BUSTER - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_COOKIES - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_FULL_URL - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_IS_HTTPS - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_LANG_ABREV - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_PATH_PARAMS - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_QUERYSTRING_PARAMS - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_REQUEST_SCOPED_VARIABLES - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_ROUTE_ID - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_SPINCAST_CURRENT_VERSION - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_GLOBAL_TEMPLATING_VAR_KEY_SPINCAST_CURRENT_VERSION_IS_SNAPSHOT - Static variable in class org.spincast.core.filters.SpincastFilters
 
DEFAULT_ROUTE_PATH - Static variable in interface org.spincast.core.routing.IRouter
The default path used when Spincast creates routes by itself.
defaultExceptionHandling(Object, Throwable) - Method in class org.spincast.core.controllers.SpincastFrontController
Default exception handling.
defaultPrivateExceptionHandling(Object, Throwable) - Method in class org.spincast.core.controllers.SpincastFrontController
Default exception handling for private exceptions
defaultPublicExceptionHandling(Object, IPublicException) - Method in class org.spincast.core.controllers.SpincastFrontController
Default exception handling for exceptions with public information.
DefaultRequestContext - Class in org.spincast.core.exchange
The default implementation of the request context.
DefaultRequestContext(Object, RequestContextBaseDeps<IDefaultRequestContext>) - Constructor for class org.spincast.core.exchange.DefaultRequestContext
 
DefaultRouteParamAliasesBinder<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Class in org.spincast.core.routing
Component that binds some default route parameter aliases.
DefaultRouteParamAliasesBinder() - Constructor for class org.spincast.core.routing.DefaultRouteParamAliasesBinder
 
DefaultWebsocketContext - Class in org.spincast.core.websocket
The default WebSocket context to pass to a WebSocket controller when an event arrives (a message is received from the peer, for example).
DefaultWebsocketContext(String, String, IWebsocketPeerManager, WebsocketContextBaseDeps<IDefaultWebsocketContext>) - Constructor for class org.spincast.core.websocket.DefaultWebsocketContext
 
DELETE() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds DELETE as a supported HTTP method.
DELETE(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a DELETE route.
deleteAllCookies() - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Deletes all cookies.
deleteAllTemplatingGlobalVariables() - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Deletes all global templating variables.
deleteCookie(String) - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Deletes a cookie.
deleteTemplatingGlobalVariable(String) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Deletes a global templating variable.
deserializeHeaderValue(String) - Method in interface org.spincast.core.routing.IETagFactory
Creates an ETag object from an already formatted ETag header.
dir(String) - Method in interface org.spincast.core.routing.IRouter
Start the creation of a static resource directory.

E

end() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Flushes everything and closes the response.
end(Object) - Method in interface org.spincast.core.server.IServer
Ends the exchange.
enter() - Method in class org.spincast.core.guice.SpincastRequestScope
 
eTag(String) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
Specifies the current ETag (strong) of the resource.
eTag(String, boolean) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
Specifies the current strong or weak ETag of the resource.
eTag(String, boolean, boolean) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
Specifies the current strong or weak ETag of the resource.
evaluate(String, Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates the content, using the given parameters.
evaluate(String, Map<String, Object>, Locale) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates the content, using the given parameters.
evaluate(String, IJsonObject) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates the content, using the given parameters.
evaluate(String, IJsonObject, Locale) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates the content, using the given parameters.
evaluate(String, Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Evaluates some content using the given parameters.
evaluate(String, Map<String, Object>, Locale) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Evaluates some content using the given parameters.
EXCEPTION - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
If an "Exception" route is run, this variable will contain the exception that occured.
exception() - Method in interface org.spincast.core.routing.IRouteBuilder
This route will be considered during an Exception routing process.
exception(IHandler<R>) - Method in interface org.spincast.core.routing.IRouter
Creates a route considered during an "Exception" routing process.
exception(String, IHandler<R>) - Method in interface org.spincast.core.routing.IRouter
Creates a route considered during an "Exception" routing process.
exception_default_message() - Method in interface org.spincast.core.config.ISpincastDictionary
The message to display if the default Exception route is used.
exchange() - Method in interface org.spincast.core.exchange.IRequestContext
The underlying exchange object, as given by the HTTP server.
exchange() - Method in class org.spincast.core.exchange.RequestContextBase
 
exit() - Method in class org.spincast.core.guice.SpincastRequestScope
 

F

FALSE - Static variable in class org.spincast.core.utils.Bool
 
file(String) - Method in interface org.spincast.core.routing.IRouter
Start the creation of a static resource file.
findRouteMatch(R) - Method in class org.spincast.core.controllers.SpincastFrontController
Find the route handlers to call.
flush() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Flushes the current response.
flush(boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Flushes the current response.
flushBytes(Object, byte[], boolean) - Method in interface org.spincast.core.server.IServer
Flushes some bytes to the response.
forceRequestSizeValidation(Object) - Method in interface org.spincast.core.server.IServer
Is the request size valid?
FORWARD_ROUTE_EXCEPTION_MESSAGE - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
If a request is forwaded, this is going to be the forwarding message (taken from the ForwardRouteException exception) The associated value is of type: String.
FORWARD_ROUTE_URL - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
When a route is forwarded, this is the new URL.
ForwardRouteException - Exception in org.spincast.core.exceptions
Exception that will forward the request to another route.
ForwardRouteException(String) - Constructor for exception org.spincast.core.exceptions.ForwardRouteException
 
ForwardRouteException(String, boolean) - Constructor for exception org.spincast.core.exceptions.ForwardRouteException
 
ForwardRouteException(String, String) - Constructor for exception org.spincast.core.exceptions.ForwardRouteException
 
ForwardRouteException(String, String, boolean) - Constructor for exception org.spincast.core.exceptions.ForwardRouteException
 
found() - Method in interface org.spincast.core.routing.IRouteBuilder
This route will be considered during a Found routing process.
from(boolean) - Static method in class org.spincast.core.utils.Bool
 
fromJsonInputStream(InputStream, Class<T>) - Method in interface org.spincast.core.json.IJsonManager
Creates an instance of the specified T type from a Json inputStream.
fromJsonInputStreamToMap(InputStream) - Method in interface org.spincast.core.json.IJsonManager
Creates a Map<String, Object> from a Json inputStream.
fromJsonString(String, Class<T>) - Method in interface org.spincast.core.json.IJsonManager
Creates an instance of the specified T type from a Json String.
fromJsonStringToMap(String) - Method in interface org.spincast.core.json.IJsonManager
Creates a Map<String, Object> from a Json String.
fromString(String) - Static method in enum org.spincast.core.utils.ContentTypeDefaults
 
fromStringValue(String) - Static method in enum org.spincast.core.routing.HttpMethod
Returns a HttpMethod from its String representation, or null if not found.
fromTemplate(String, Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the given parameters.
fromTemplate(String, Map<String, Object>, Locale) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the given parameters.
fromTemplate(String, IJsonObject) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the parameters specified as a IJsonObject.
fromTemplate(String, IJsonObject, Locale) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the parameters specified as a IJsonObject.
fromTemplate(String, boolean, Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the given parameters.
fromTemplate(String, boolean, Map<String, Object>, Locale) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the given parameters.
fromTemplate(String, boolean, IJsonObject) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the parameters specified as a IJsonObject.
fromTemplate(String, boolean, IJsonObject, Locale) - Method in interface org.spincast.core.templating.ITemplatingEngine
Evaluates a template using the parameters specified as a IJsonObject.
fromTemplate(String, Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Renders a template using the given parameters.
fromTemplate(String, Map<String, Object>, Locale) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Renders a template usgin the given parameters.
fromTemplate(String, boolean, Map<String, Object>) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Renders a template using the given parameters.
fromTemplate(String, boolean, Map<String, Object>, Locale) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Renders a template usgin the given parameters.
fromXml(String) - Method in interface org.spincast.core.xml.IXmlManager
Deserializes a XML to an IJsonObject.
fromXml(String, Class<T>) - Method in interface org.spincast.core.xml.IXmlManager
Deserializes a XML to the given Class.
fromXmlInputStream(InputStream, Class<T>) - Method in interface org.spincast.core.xml.IXmlManager
Deserializes a XML inputstream to the given Type.
fromXmlToJsonArray(String) - Method in interface org.spincast.core.xml.IXmlManager
Deserializes a XML to an IJsonArray.
fromXmlToType(String, Type) - Method in interface org.spincast.core.xml.IXmlManager
Deserializes a XML to the given Type.

G

generatePeerId(R, String) - Method in class org.spincast.core.websocket.WebsocketRouteHandler
Generate a peer id when none is specified by the controller.
geNumericAliasKey() - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Numeric alias
geNumericPlusAliasKey() - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Numeric + "_" and "-" alias
get(Class<T>) - Method in interface org.spincast.core.exchange.IRequestContext
Shortcut to get an instance from Guice.
get(Key<T>) - Method in interface org.spincast.core.exchange.IRequestContext
Shortcut to get an instance from Guice.
get(String) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Gets the specified request scoped variable.
get(String, Class<T>) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Gets the specified request scoped variable as the specified class.
get(String, Key<T>) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Gets the specified request scoped variable as the specified Key.
get(Class<T>) - Method in class org.spincast.core.exchange.RequestContextBase
 
get(Key<T>) - Method in class org.spincast.core.exchange.RequestContextBase
 
get(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element at the specified position.
get(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property.
get(String, Object) - Method in interface org.spincast.core.json.IJsonObject
Gets a property.
get(int) - Method in class org.spincast.core.json.JsonArray
 
get(String) - Method in class org.spincast.core.json.JsonObject
 
get(String, Object) - Method in class org.spincast.core.json.JsonObject
 
GET() - Method in interface org.spincast.core.routing.IRouteBuilder
Addss GET as a supported HTTP method.
GET(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a GET route.
get(Class<T>) - Method in interface org.spincast.core.websocket.IWebsocketContext
Shortcut to get an instance from Guice.
get(Key<T>) - Method in interface org.spincast.core.websocket.IWebsocketContext
Shortcut to get an instance from Guice.
get(Class<T>) - Method in class org.spincast.core.websocket.WebsocketContextBase
 
get(Key<T>) - Method in class org.spincast.core.websocket.WebsocketContextBase
 
getAcceptedContentTypes() - Method in interface org.spincast.core.routing.IRoute
The Content-Types this route accepts (names all lowercased).
getAfterFilters() - Method in interface org.spincast.core.routing.IRoute
The "after" filters, if any.
getAll() - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Gets all the request scoped variables.
getAllContentTypesVariations() - Static method in enum org.spincast.core.utils.ContentTypeDefaults
 
getAllowedMethods() - Method in interface org.spincast.core.filters.ICorsFilterClient
The allowed HTTP methods, for the cors request.
getAllowedOrigins() - Method in interface org.spincast.core.filters.ICorsFilterClient
The allowed origins, for the cors request.
getAllowedOrigins() - Method in interface org.spincast.core.routing.IStaticResourceCorsConfig
The allowed origins.
getAlphaAliasKey() - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Alpha alias
getAlphaNumericAliasKey() - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Alphanumeric alias
getAlphaNumericPlusAliasKey() - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Alphanumeric + "_" and "-" alias
getAlphaPlusAliasKey() - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Alpha + "_" and "-" alias
getAppJarDirectory() - Method in interface org.spincast.core.utils.ISpincastUtils
Returns the working directory: the directory in which the executable .jar is located.
getAppJarDirectory() - Method in class org.spincast.core.utils.SpincastUtils
 
getAsJsonObject(String) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Gets the specified request scoped variable as JsonObject.
getAsString(String) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Gets the specified request scoped variable as a String.
getBeforeFilters() - Method in interface org.spincast.core.routing.IRoute
The "before" filters, if any.
getBeforeFilters() - Method in interface org.spincast.core.websocket.IWebsocketRoute
The "before" filters, if any.
getBigDecimal(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as BigDecimal.
getBigDecimal(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as BigDecimal.
getBigDecimal(String, BigDecimal) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as BigDecimal.
getBigDecimal(int) - Method in class org.spincast.core.json.JsonArray
 
getBigDecimal(String) - Method in class org.spincast.core.json.JsonObject
 
getBigDecimal(String, BigDecimal) - Method in class org.spincast.core.json.JsonObject
 
getBigDecimalValue(String, boolean, BigDecimal) - Method in class org.spincast.core.json.JsonObject
 
getBodyAsByteArray() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The bytes of the request's body.
getBodyAsInputStream() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The raw InputStream of the request's body.
getBodyAsString() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body as a String, using the UTF-8 encoding.
getBodyAsString(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body as a String, using the specified encoding.
getBoolean(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as Boolean.
getBoolean(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Boolean.
getBoolean(String, Boolean) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Boolean.
getBoolean(int) - Method in class org.spincast.core.json.JsonArray
 
getBoolean(String) - Method in class org.spincast.core.json.JsonObject
 
getBoolean(String, Boolean) - Method in class org.spincast.core.json.JsonObject
 
getBoolean() - Method in class org.spincast.core.utils.Bool
 
getBooleanValue(String, boolean, Boolean) - Method in class org.spincast.core.json.JsonObject
 
getBytesFromBase64String(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a byte array, from a base 64 encoded property.
getBytesFromBase64String(String, byte[]) - Method in interface org.spincast.core.json.IJsonObject
Gets a byte array, from a base 64 encoded property.
getBytesFromBase64String(String) - Method in class org.spincast.core.json.JsonObject
 
getBytesFromBase64String(String, byte[]) - Method in class org.spincast.core.json.JsonObject
 
getBytesFromBase64StringValue(String, boolean, byte[]) - Method in class org.spincast.core.json.JsonObject
 
getCacheBusterCode() - Method in interface org.spincast.core.utils.ISpincastUtils
The cache buster to use.
getCacheBusterCode() - Method in class org.spincast.core.utils.SpincastUtils
 
getCacheCdnSecondsByDefault() - Method in class org.spincast.core.filters.SpincastFilters
 
getCacheConfig() - Method in interface org.spincast.core.routing.IStaticResource
The cache configurations for the static resource.
getCacheHeadersRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getCacheHeadersRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getCacheSeconds() - Method in interface org.spincast.core.routing.IStaticResourceCacheConfig
The number of seconds to use when sending caching headers.
getCacheSecondsByDefault() - Method in class org.spincast.core.filters.SpincastFilters
 
getCacheSecondsCdn() - Method in interface org.spincast.core.routing.IStaticResourceCacheConfig
The number of seconds to use to cache by CDNs.
getCharactersCharsetName() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The charset to use to convert characters to bytes.
getContentType() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The Content-Type of the request, if any.
getContentType() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The current Content-Type sent or to be send.
getContentTypeBestMatch() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Finds the best Content-Type to use for a response using the "Accept" header of the request.
getContentTypeBestMatch(Object) - Method in interface org.spincast.core.server.IServer
Gets the best Content-Type to use for the current request.
getContentTypesToSkipGziping() - Method in interface org.spincast.core.config.ISpincastConfig
Even if gziping of the response is enabled, those Content-Types still won't be gzipped.
getController() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getCookie(String) - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Gets a cookie.
getCookies() - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Gets the current cookies in a Map, using their names as the keys.
getCookies(Object) - Method in interface org.spincast.core.server.IServer
Gets the current cookies.
getCookiesRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getCookiesRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getCorsConfig() - Method in interface org.spincast.core.routing.IStaticResource
The cors configurations for the static resource.
getCorsDefaultAllowedMethods() - Method in class org.spincast.core.filters.SpincastFilters
The HTTP methods allowed by default.
getCorsDefaultAllowedOrigins() - Method in class org.spincast.core.filters.SpincastFilters
The origins allowed, by default.
getCorsDefaultExtraHeadersAllowedToBeRead() - Method in class org.spincast.core.filters.SpincastFilters
The extra headers allowed to be read, by default,
getCorsDefaultExtraHeadersAllowedToBeSent() - Method in class org.spincast.core.filters.SpincastFilters
The extra headers allowed to be sent, by default,
getCorsDefaultIsCookiesAllowed() - Method in class org.spincast.core.filters.SpincastFilters
Are cookies allowed by default?
getCorsDefaultMaxAgeInSeconds() - Method in class org.spincast.core.filters.SpincastFilters
If <= 0, the "Access-Control-Max-Age" header won't be sent.
getCorsFilter() - Method in class org.spincast.core.filters.SpincastFilters
 
getCorsFilterClass() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getCurrentManagingControllerKey() - Method in exception org.spincast.core.websocket.exceptions.WebsocketEndpointAlreadyManagedByAnotherControllerException
 
getCurrentRouteHandlerMatch() - Method in interface org.spincast.core.routing.IRoutingRequestContextAddon
The current route handler being run (may be a filter) and its associated information.
getCurrentVersionFromPom() - Method in class org.spincast.core.utils.SpincastUtils
 
getDate(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a UTC timezoned date from a ISO 8601 date property.
getDate(String, Date) - Method in interface org.spincast.core.json.IJsonObject
Gets a UTC timezoned date from a ISO 8601 date property.
getDate(String) - Method in class org.spincast.core.json.JsonObject
 
getDate(String, Date) - Method in class org.spincast.core.json.JsonObject
 
getDateFromIfModifiedSinceHeader() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Return the value of the If-Modified-Since header as a Date or null if it doesn't exist.
getDateFromIfUnmodifiedSinceHeader() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Return the value of the If-Unmodified-Since header as a Date or null if it doesn't exist.
getDateValue(String, boolean, Date) - Method in class org.spincast.core.json.JsonObject
 
getDefaultExceptionHandlingCharset() - Method in class org.spincast.core.controllers.SpincastFrontController
Charset used by the default exception handling.
getDefaultHeadersAllowedToBeSent() - Method in class org.spincast.core.filters.CorsFilter
 
getDefaultLocale() - Method in interface org.spincast.core.config.ISpincastConfig
The default Locale to use if no other Locale can be found as a "best match", for the current request.
getDefaultNotFoundHandler() - Method in class org.spincast.core.controllers.SpincastFrontController
Create the default Not Found handler
getDefaultNotFoundHandlerNotFoundMessage() - Method in class org.spincast.core.controllers.SpincastFrontController
The message to send for the default Not Found handler.
getDefaultRouteCacheFilterSecondsNbr() - Method in interface org.spincast.core.config.ISpincastConfig
When using the .cache() method on a route builder, this is the default number of seconds to use.
getDefaultRouteCacheFilterSecondsNbrCdns() - Method in interface org.spincast.core.config.ISpincastConfig
When using the .cache() method on a route builder, this is the default number of seconds to use by the CDNs.
getDefaultStaticResourceCacheConfig(boolean) - Method in interface org.spincast.core.config.ISpincastConfig
The default cache configurations for the static resource.
getDefaultTemplateVariablesFilterPosition() - Method in interface org.spincast.core.config.ISpincastConfig
If addGlobalTemplateVariablesAdderFilter erturns true/code>, then this is the position at which the filter will be added.
getDomain() - Method in interface org.spincast.core.cookies.ICookie
Gets the cookie domain.
getDouble(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as Double.
getDouble(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Double.
getDouble(String, Double) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Double.
getDouble(int) - Method in class org.spincast.core.json.JsonArray
 
getDouble(String) - Method in class org.spincast.core.json.JsonObject
 
getDouble(String, Double) - Method in class org.spincast.core.json.JsonObject
 
getDoubleValue(String, boolean, Double) - Method in class org.spincast.core.json.JsonObject
 
getElements() - Method in class org.spincast.core.json.JsonArray
 
getEndpointCreationLock(String) - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
getEndpointId() - Method in interface org.spincast.core.websocket.IWebsocketConnectionConfig
The endpoint id to use.
getEndpointId() - Method in interface org.spincast.core.websocket.IWebsocketContext
The id of the endpoint
getEndpointId() - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
The endpoint id
getEndpointId() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
getEndpointId() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getEndpointManager() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getEndpointToControllerMap() - Method in class org.spincast.core.websocket.WebsocketEndpointToControllerManager
 
getEnvironmentName() - Method in interface org.spincast.core.config.ISpincastConfig
Returns the name of the environment.
getEtagsFromIfMatchHeader() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Returns the ETags from the If-Match header, if any.
getEtagsFromIfNoneMatchHeader() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Returns the ETags from the If-None-Match header, if any.
getExpires() - Method in interface org.spincast.core.cookies.ICookie
Gets the date the cookie will expire at.
getExtraHeadersAllowedToBeRead() - Method in interface org.spincast.core.filters.ICorsFilterClient
The extra headers allowed to be read, for the cors request.
getExtraHeadersAllowedToBeRead() - Method in interface org.spincast.core.routing.IStaticResourceCorsConfig
The extra headers a browser will be allowed to read.
getExtraHeadersAllowedToBeSent() - Method in interface org.spincast.core.filters.ICorsFilterClient
The extra headers allowed to be sent, for the cors request.
getExtraHeadersAllowedToBeSent() - Method in interface org.spincast.core.routing.IStaticResourceCorsConfig
The extra headers a browser will be allowed to send.
getFilterIdsToSkip() - Method in interface org.spincast.core.routing.IRoute
The ids of the filters that should be skipped for this route.
getFilterIdsToSkip() - Method in interface org.spincast.core.websocket.IWebsocketRoute
The ids of the filters that should be skipped for this route.
getFloat(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Float.
getFloat(String, Float) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Float.
getFloat(String) - Method in class org.spincast.core.json.JsonObject
 
getFloat(String, Float) - Method in class org.spincast.core.json.JsonObject
 
getFloatValue(String, boolean, Float) - Method in class org.spincast.core.json.JsonObject
 
getFormData(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
A specific parameter submitted from a FORM via a POST method.
getFormDataFirst(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The first (and often only) value of a specific parameter submitted from a FORM via a POST method.
getFormDatas() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The parameters submitted from a FORM via a POST method.
getFormDatas(Object) - Method in interface org.spincast.core.server.IServer
The form datas, if any.
getFrontControllerKey() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getFullUrl() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Returns the current full URL, including the queryString, if any.
getFullUrl(boolean) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Returns the current full URL, including the queryString, if any.
getFullUrl() - Method in interface org.spincast.core.filters.ICorsFilterClient
Gets the full URL of the request.
getFullUrlOriginal() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
If the request has been forwarded, this is going to return the original URL, not the current, forwarded, one.
getFullUrlOriginal(boolean) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
If the request has been forwarded, this is going to return the original URL, not the current, forwarded, one.
getFullUrlOriginal(Object) - Method in interface org.spincast.core.server.IServer
The full encoded URL of the original, non proxied, request, including the queryString.
getFullUrlOriginal(Object, boolean) - Method in interface org.spincast.core.server.IServer
The full encoded URL of the original, non proxied, request, including the queryString.
getFullUrlProxied() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
If a reverse proxy has been used, this URL will contain the scheme, host and port as forwarded by the reserve proxy, not as seen by the user.
getFullUrlProxied(boolean) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
If a reverse proxy has been used, this URL will contain the scheme, host and port as forwarded by the reserve proxy, not as seen by the user.
getFullUrlProxied(Object) - Method in interface org.spincast.core.server.IServer
The full encoded URL of the potentially proxied request, including the queryString.
getFullUrlProxied(Object, boolean) - Method in interface org.spincast.core.server.IServer
The full encoded URL of the potentially proxied request, including the queryString.
getGenerator() - Method in interface org.spincast.core.routing.IStaticResource
The generator to call to generate this resource if it doesn't exist yet.
getGlobalAfterFiltersRoutes() - Method in interface org.spincast.core.routing.IRouter
Gets the global "after" filters.
getGlobalBeforeFiltersRoutes() - Method in interface org.spincast.core.routing.IRouter
Gets the global "before" filters.
getGzipOption() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The currently set gzip options.
getHandler() - Method in interface org.spincast.core.routing.IRouteHandlerMatch
The route handler.
getHeader(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Returns the values of the specified header from the current request or an empty list if not found.
getHeader(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The values of a specific response header.
getHeaderFirst(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The first value of the specified header from the current request.
getHeaderFirst(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The first value of a specific header.
getHeaderFirst(String) - Method in interface org.spincast.core.filters.ICorsFilterClient
Gets the first value of an header.
getHeaders() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Returns all headers of the current request.
getHeaders() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The currently set response headers.
getHeaderValue() - Method in interface org.spincast.core.routing.IETag
Gets the HTTP header value to use for this ETag.
getHttpAuthenticationRealms() - Method in interface org.spincast.core.server.IServer
Returns the existing HTTP authentication realms, the key being the realm's name and the value being the prefix path associated to this realm.
getHttpMethod() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Gets the request's HTTP method.
getHttpMethod() - Method in interface org.spincast.core.filters.ICorsFilterClient
Gets the request's HTTP method.
getHttpMethod(Object) - Method in interface org.spincast.core.server.IServer
Gets the HTTP method associated with the request.
getHttpMethods() - Method in interface org.spincast.core.routing.IRoute
The HTTP methods this route applies to.
getHttpServerPort() - Method in interface org.spincast.core.config.ISpincastConfig
The HTTP (unsecure) port on which the server will listen on.
getHttpsKeyStoreKeypass() - Method in interface org.spincast.core.config.ISpincastConfig
The "keypass" of the KeyStore, for SSL.
getHttpsKeyStorePath() - Method in interface org.spincast.core.config.ISpincastConfig
The path to the KeyStore, for SSL.
getHttpsKeyStoreStorePass() - Method in interface org.spincast.core.config.ISpincastConfig
The "storepass" of the KeyStore, for SSL.
getHttpsKeyStoreType() - Method in interface org.spincast.core.config.ISpincastConfig
The type of the KeyStore, for SSL.
getHttpsServerPort() - Method in interface org.spincast.core.config.ISpincastConfig
The HTTPS (secure) port on which the server will listen on.
getId() - Method in interface org.spincast.core.routing.IRoute
The route id.
getId() - Method in interface org.spincast.core.websocket.IWebsocketRoute
The WebSocket route id.
getInjectorProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getInjectorProvider() - Method in class org.spincast.core.websocket.WebsocketContextBaseDeps
 
getInstance() - Static method in class org.spincast.core.utils.SpincastStatics
 
getInstanceFromGuiceCache() - Method in class org.spincast.core.exchange.RequestContextBase
 
getInstanceFromGuiceCache() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
getInteger(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as Integer.
getInteger(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Integer.
getInteger(String, Integer) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Integer.
getInteger(int) - Method in class org.spincast.core.json.JsonArray
 
getInteger(String) - Method in class org.spincast.core.json.JsonObject
 
getInteger(String, Integer) - Method in class org.spincast.core.json.JsonObject
 
getIntegerValue(String, boolean, Integer) - Method in class org.spincast.core.json.JsonObject
 
getInternalErrorHtmlContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getInternalErrorJsonContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getInternalErrorTextContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getInternalErrorXmlContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getJsonArray(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as IJsonArray.
getJsonArray(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as IJsonArray.
getJsonArray(String, IJsonArray) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as IJsonArray.
getJsonArray(int) - Method in class org.spincast.core.json.JsonArray
 
getJsonArray(String) - Method in class org.spincast.core.json.JsonObject
 
getJsonArray(String, IJsonArray) - Method in class org.spincast.core.json.JsonObject
 
getJsonArrayKey() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getJsonArrayValue(String, boolean, IJsonArray) - Method in class org.spincast.core.json.JsonObject
 
getJsonBody(Class<T>) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body deserialized to the specified class.
getJsonBodyAsJsonObject() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body deserialized to a IJsonObject.
getJsonBodyAsMap() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body deserialized to a Map<String, Object>.
getJsonManager() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getJsonManager() - Method in class org.spincast.core.exchange.RequestContextBase
 
getJsonManager() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getJsonManager() - Method in class org.spincast.core.json.JsonArray
 
getJsonManager() - Method in class org.spincast.core.json.JsonObject
 
getJsonManager() - Method in class org.spincast.core.websocket.WebsocketContextBaseDeps
 
getJsonObject(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as IJsonObject.
getJsonObject(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as IJsonObject.
getJsonObject(String, IJsonObject) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as IJsonObject.
getJsonObject(int) - Method in class org.spincast.core.json.JsonArray
 
getJsonObject(String) - Method in class org.spincast.core.json.JsonObject
 
getJsonObject(String, IJsonObject) - Method in class org.spincast.core.json.JsonObject
 
getJsonObjectKey() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getJSONObjectValue(String, boolean, IJsonObject) - Method in class org.spincast.core.json.JsonObject
 
getKey() - Method in exception org.spincast.core.json.IJsonObject.KeyNotFoundException
The key that wasn not found.
getKeyManagers(String, String, String, String) - Method in class org.spincast.core.utils.ssl.SSLContextFactory
 
getKeyStore(String, String, String) - Method in class org.spincast.core.utils.ssl.SSLContextFactory
 
getKeyStoreInputStream(String) - Method in class org.spincast.core.utils.ssl.SSLContextFactory
 
getLocaleBestMatch() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Find the best Locale to use for a response using the "Accept-Language" header of the request.
getLocaleBestMatchFromAcceptLanguageHeader(String) - Method in interface org.spincast.core.utils.ISpincastUtils
Gets the best Locale to use given a "Accept-Language" HTTP header.
getLocaleBestMatchFromAcceptLanguageHeader(String) - Method in class org.spincast.core.utils.SpincastUtils
 
getLocaleResolver() - Method in class org.spincast.core.exchange.RequestContextBase
 
getLocaleResolver() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getLocaleResolver() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
getLocaleResolver() - Method in class org.spincast.core.websocket.WebsocketContextBaseDeps
 
getLocaleToUse() - Method in interface org.spincast.core.exchange.IRequestContext
The best Locale to use, as resolved by the LocaleResolver.
getLocaleToUse() - Method in class org.spincast.core.exchange.RequestContextBase
 
getLocaleToUse() - Method in interface org.spincast.core.locale.ILocaleResolver
The best Locale to use.
getLocaleToUse() - Method in interface org.spincast.core.websocket.IWebsocketContext
The best Locale to use, as resolved by the LocaleResolver during the initial HTTP request.
getLocaleToUse() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
getLong(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as Long.
getLong(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Long.
getLong(String, Long) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as Long.
getLong(int) - Method in class org.spincast.core.json.JsonArray
 
getLong(String) - Method in class org.spincast.core.json.JsonObject
 
getLong(String, Long) - Method in class org.spincast.core.json.JsonObject
 
getLongValue(String, boolean, Long) - Method in class org.spincast.core.json.JsonObject
 
getMainArgs() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getMainHandler() - Method in interface org.spincast.core.routing.IRoute
The main handler.
getMainRouteHandlerMatch() - Method in interface org.spincast.core.routing.IRoutingResult
The main route handler and its information, from the routing result.
getMainRoutes() - Method in interface org.spincast.core.routing.IRouter
Gets the main routes.
getMainVariation() - Method in enum org.spincast.core.utils.ContentTypeDefaults
 
getMainVariationWithUtf8Charset() - Method in enum org.spincast.core.utils.ContentTypeDefaults
 
getMaxAgeInSeconds() - Method in interface org.spincast.core.filters.ICorsFilterClient
The max age to cache a cors preflight response.
getMaxAgeInSeconds() - Method in interface org.spincast.core.routing.IStaticResourceCorsConfig
The max Age a preflight request can be cached.
getMimeTypeFromExtension(String) - Method in interface org.spincast.core.utils.ISpincastUtils
Gets the mime type from the extension.
getMimeTypeFromExtension(String) - Method in class org.spincast.core.utils.SpincastUtils
 
getMimeTypeFromMultipleSources(String, String, String) - Method in interface org.spincast.core.utils.ISpincastUtils
Gets the mime type using multiple sources of information.
getMimeTypeFromMultipleSources(String, String, String) - Method in class org.spincast.core.utils.SpincastUtils
 
getMimeTypeFromPath(String) - Method in interface org.spincast.core.utils.ISpincastUtils
Gets the mime type from a path, using its extension.
getMimeTypeFromPath(String) - Method in class org.spincast.core.utils.SpincastUtils
 
getName() - Method in interface org.spincast.core.cookies.ICookie
Gets the cookie name.
getNewControllerKey() - Method in exception org.spincast.core.websocket.exceptions.WebsocketEndpointAlreadyManagedByAnotherControllerException
 
getNewRoute() - Method in exception org.spincast.core.exceptions.ForwardRouteException
The new route to forward to.
getNewUrl() - Method in exception org.spincast.core.exceptions.RedirectException
The new route to redirect to.
getNotFoundHtmlContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getNotFoundJsonContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getNotFoundPlainTextContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getNotFoundXmlContent(String) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getPath() - Method in interface org.spincast.core.cookies.ICookie
Gets the cookie path.
getPath() - Method in interface org.spincast.core.routing.IRoute
The route path.
getPath() - Method in interface org.spincast.core.websocket.IWebsocketRoute
The WebSocket route path.
getPathParam(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
A specific value parsed from a dynamic parameter of the route path.
getPathParams() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The values parsed from the dynamic parameters of the route path.
getPathParams() - Method in interface org.spincast.core.routing.IRouteHandlerMatch
The values parsed from the URL, given the dynamic parameters of the route's path, if any.
getPeerContextesMap() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getPeerId() - Method in interface org.spincast.core.websocket.IWebsocketConnectionConfig
The id to attribute to the connecting peer.
getPeerId() - Method in interface org.spincast.core.websocket.IWebsocketContext
The id of the peer.
getPeerId() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
getPeersIds() - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
The connected peers' ids.
getPosition() - Method in interface org.spincast.core.routing.IRouteHandlerMatch
The position the handler should be run at.
getPosition() - Method in interface org.spincast.core.routing.IRoutingRequestContextAddon
The current route handler position.
getPositions() - Method in interface org.spincast.core.routing.IRoute
The positions at which this route should be run during a routing process.
getQueryString(boolean) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The queryString of the request.
getQueryStringParam(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
A specific parameter taken from the queryString of the request.
getQueryStringParamFirst(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The first (and often only) value of a specific parameter taken from the queryString of the request.
getQueryStringParams() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The parameters taken from the queryString of the request.
getQueryStringParams(Object) - Method in interface org.spincast.core.server.IServer
Gets the queryString parameters.
getRawInputStream(Object) - Method in interface org.spincast.core.server.IServer
The raw InputStream of the current request.
getRequestContextFactory() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getRequestContextImplementationClass() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
The implementation to use for the request context objects.
getRequestContextType() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getRequestContextType() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getRequestContextType() - Method in class org.spincast.core.guice.SpincastGuiceModuleBase
The type of the request context objects.
getRequestContextType() - Method in class org.spincast.core.guice.SpincastPluginGuiceModuleBase
 
getRequestHeaders(Object) - Method in interface org.spincast.core.server.IServer
The headers from the request.
getRequestPath() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The path of the request (no querystring).
getRequestPath(boolean) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The path of the request (no querystring).
getRequestRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getRequestRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getRequestScheme(Object) - Method in interface org.spincast.core.server.IServer
Gets the request scheme, "http" for example.
getResourcePath() - Method in interface org.spincast.core.routing.IStaticResource
The path of the resource on the classpath or on the file system.
getResponseContentTypeToUse(Object) - Method in class org.spincast.core.controllers.SpincastFrontController
 
getResponseHeaders(Object) - Method in interface org.spincast.core.server.IServer
Gets the response headers.
getResponseRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getResponseRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getRoute(String) - Method in interface org.spincast.core.routing.IRouter
Gets a route using its routeId.
getRouteForwardingMaxNumber() - Method in interface org.spincast.core.config.ISpincastConfig
The maximum number of time a request can be forwarded to another route.
getRouteHandlerMatches() - Method in interface org.spincast.core.routing.IRoutingResult
The handlers matching the route (a main handler + filters, if any), in order they have to be called.
getRouteParamPatternAliases() - Method in interface org.spincast.core.routing.IRouter
The path patterns' aliases.
getRouter() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getRoutingRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getRoutingRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getRoutingResult() - Method in interface org.spincast.core.routing.IRoutingRequestContextAddon
The routing result for the current request, as returned by the router.
getRoutingTypes() - Method in interface org.spincast.core.routing.IRoute
The routing types the route should be considered for.
getScopedObjectMap(Key<T>) - Method in class org.spincast.core.guice.SpincastRequestScope
 
getSeedErrorProvider(Key) - Static method in class org.spincast.core.guice.SpincastRequestScope
Returns a provider that always throws exception complaining that the object in question must be seeded before it can be injected.
getServer() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getServer() - Method in class org.spincast.core.filters.SpincastFilters
 
getServer() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getServer() - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
getServerEndpointHandlers() - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
getServerHost() - Method in interface org.spincast.core.config.ISpincastConfig
The host/IP on which the server will listen to.
getServerMaxRequestBodyBytes() - Method in interface org.spincast.core.config.ISpincastConfig
Maximum number of bytes a request's body can have.
getSourceRoute() - Method in interface org.spincast.core.routing.IRouteHandlerMatch
The route associated with this match.
getSpincastConfig() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getSpincastConfig() - Method in class org.spincast.core.filters.SpincastFilters
 
getSpincastConfig() - Method in class org.spincast.core.utils.SpincastUtils
 
getSpincastCurrentVersion() - Method in interface org.spincast.core.utils.ISpincastUtils
Gets the current Spincast version.
getSpincastCurrentVersion() - Method in class org.spincast.core.utils.SpincastUtils
 
getSpincastDictionary() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getSpincastFiltersKey() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getSpincastRequestScope() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getSpincastUtils() - Method in class org.spincast.core.filters.SpincastFilters
 
getSpincastUtilsKey() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getSpincastWritableDir() - Method in interface org.spincast.core.config.ISpincastConfig
A directory where temporary generated files can be written by Spincast.
getSSLContextFactoryClass() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getStackTrace(Throwable) - Static method in class org.spincast.core.utils.SpincastStatics
Gets the stack trace of an Exception.
getStackTraceInstance(Throwable) - Method in class org.spincast.core.utils.SpincastStatics
 
getStaticResourceServed(String) - Method in interface org.spincast.core.server.IServer
Gets a static resource served directly by the server, using its path.
getStaticResourcesServed() - Method in interface org.spincast.core.server.IServer
Gets all static resource served directly by the server.
getStaticResourceType() - Method in interface org.spincast.core.routing.IStaticResource
The type of static resource.
getStatusCode() - Method in exception org.spincast.core.exceptions.CustomStatusCodeException
 
getStatusCode() - Method in interface org.spincast.core.exceptions.ICustomStatusCodeException
The status code to use for the response.
getStatusCode() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The current status code sent or to be send.
getString(int) - Method in interface org.spincast.core.json.IJsonArray
Gets an element as String.
getString(String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as String.
getString(String, String) - Method in interface org.spincast.core.json.IJsonObject
Gets a property as String.
getString(int) - Method in class org.spincast.core.json.JsonArray
 
getString(String) - Method in class org.spincast.core.json.JsonObject
 
getString(String, String) - Method in class org.spincast.core.json.JsonObject
 
getStringValue(String, boolean, String) - Method in class org.spincast.core.json.JsonObject
 
getTag() - Method in interface org.spincast.core.routing.IETag
Gets the tag text.
getTemplatingEngine() - Method in class org.spincast.core.websocket.WebsocketContextBaseDeps
 
getTemplatingGlobalVariable(String) - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
Gets a global templating variable.
getTemplatingGlobalVariables() - Method in interface org.spincast.core.templating.ITemplatingRequestContextAddon
The global templating variables.
getTemplatingRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getTemplatingRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getTrustManagers() - Method in class org.spincast.core.utils.ssl.SSLContextFactory
 
getUnderlyingList() - Method in interface org.spincast.core.json.IJsonArray
The underlying list.
getUnderlyingList() - Method in class org.spincast.core.json.JsonArray
 
getUnderlyingMap() - Method in interface org.spincast.core.json.IJsonObject
The underlying map.
getUnderlyingMap() - Method in class org.spincast.core.json.JsonObject
 
getUnsentBytes() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Gets the current unsent bytes (AKA the buffer).
getUnsentCharacters() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Gets the current unsent characters (AKA the buffer), using the UTF-8 encoding.
getUnsentCharacters(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Gets the current unsent characters (AKA the buffer), using the specified encoding.
getUploadedFileFirst(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The first (and often only) uploaded file of the specified name.
getUploadedFiles() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The uploaded files, with their names as the keys.
getUploadedFiles(String) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The uploaded files of the specified name.
getUploadedFiles(Object) - Method in interface org.spincast.core.server.IServer
The uploaded files, if any.
getUrlPath() - Method in interface org.spincast.core.routing.IStaticResource
The URL to reach this static resource.
getValue() - Method in interface org.spincast.core.cookies.ICookie
Gets the cookie value.
getValue(String, boolean, Object) - Method in class org.spincast.core.json.JsonObject
 
getValueDyn(String, boolean, T, Class<T>, Function<Object, T>) - Method in class org.spincast.core.json.JsonObject
 
getVariablesRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBase
 
getVariablesRequestContextAddonProvider() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getVariations() - Method in enum org.spincast.core.utils.ContentTypeDefaults
 
getVersion() - Method in interface org.spincast.core.cookies.ICookie
Gets the cookie version.
getWebsocketContextFactory() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getWebsocketContextImplementationClass() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
The implementation to use for the Websocket context objects.
getWebsocketContextType() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getWebsocketContextType() - Method in class org.spincast.core.guice.SpincastGuiceModuleBase
The type of the Websocket context objects.
getWebsocketContextType() - Method in class org.spincast.core.guice.SpincastPluginGuiceModuleBase
 
getWebsocketController() - Method in interface org.spincast.core.websocket.IWebsocketRoute
The WebSocket controller to use.
getWebsocketEndpointHandlerKey() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getWebsocketEndpointManager(String) - Method in interface org.spincast.core.server.IServer
Returns the manager for a Websockets endpoint.
getWebsocketEndpointManagers() - Method in interface org.spincast.core.server.IServer
Returns the managers of the existing Websockets endpoints.
getWebsocketEndpointToControllerKeysMapClass() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
 
getWebsocketEndpointToControllerManager() - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
getWebsocketPeerContext(String) - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
getWebsocketRoute() - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
getWebsocketServerEndpointHandlerFactory() - Method in class org.spincast.core.websocket.WebsocketRouteHandler
 
getXmlBody(Class<T>) - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body deserialized to the specified class.
getXmlBodyAsJsonObject() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body deserialized to a IJsonObject.
getXmlBodyAsMap() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
The request's body deserialized to a Map<String, Object>.
getXmlManager() - Method in class org.spincast.core.controllers.SpincastFrontController
 
getXmlManager() - Method in class org.spincast.core.exchange.RequestContextBase
 
getXmlManager() - Method in class org.spincast.core.exchange.RequestContextBaseDeps
 
getXmlManager() - Method in class org.spincast.core.websocket.WebsocketContextBaseDeps
 
guice() - Method in interface org.spincast.core.exchange.IRequestContext
Easy access to the Guice context.
guice() - Method in class org.spincast.core.exchange.RequestContextBase
 
guice() - Method in interface org.spincast.core.websocket.IWebsocketContext
Easy access to the Guice context.
guice() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
GzipOption - Enum in org.spincast.core.utils
Control how gzip should be applied on a route.

H

handle(Object) - Method in interface org.spincast.core.controllers.IFrontController
 
handle(Object) - Method in class org.spincast.core.controllers.SpincastFrontController
Front controller's handle() method, called by the HTTP server.
handle(R) - Method in interface org.spincast.core.routing.IHandler
Receives a request context object and handles it.
handle(R) - Method in class org.spincast.core.websocket.WebsocketRouteHandler
The handle() method for WebSocket handshaking, called by the front controller once the potential "before" filters have been ran.
HEAD() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds HEAD as a supported HTTP method.
HEAD(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a HEAD route.
html() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds application/html as an accepted Content-Type.
httpAuth(String, String) - Method in interface org.spincast.core.routing.IRouter
Creates HTTP authentication protection (realm) for the specified path prefix.
HttpMethod - Enum in org.spincast.core.routing
Enum for the HTTP methods.

I

ICacheHeadersRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.exchange
Request context add-on to work with cache headers.
ICookie - Interface in org.spincast.core.cookies
An HTTP cookie.
ICookieFactory - Interface in org.spincast.core.cookies
Factory to create cookies.
ICookiesRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.cookies
Request context add-on to work with cookies.
ICorsFilter - Interface in org.spincast.core.filters
Filter to validate if a request contains valid cors headers and, if so, add the required headers as a response.
ICorsFilterClient - Interface in org.spincast.core.filters
Interface for a client of the Cors filter.
ICustomStatusCodeException - Interface in org.spincast.core.exceptions
An exception on which it is possible to specify the response status code to send to the user.
id(String) - Method in interface org.spincast.core.routing.IRouteBuilder
An id that can be used to identify the route.
id(String) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilder
The WebSocket route id.
IDefaultRequestContext - Interface in org.spincast.core.exchange
The unparamaterized interface for the default request context.
IDefaultWebsocketContext - Interface in org.spincast.core.websocket
The unparamaterized interface for the default WebSocket context.
IDefaultWebsocketRoute - Interface in org.spincast.core.websocket
Default WebSocket route.
IETag - Interface in org.spincast.core.routing
Represents an HTTP ETag.
IETagFactory - Interface in org.spincast.core.routing
Factory for ETags
IFrontController - Interface in org.spincast.core.controllers
The front controller is called by the HTTP server when a request for something else than a static resource arrives.
IHandler<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
A route handler.
IJsonArray - Interface in org.spincast.core.json
Represents a Json array "[]", and makes it easier to get its elements in a typed way.
IJsonManager - Interface in org.spincast.core.json
Provides methods to play with Json strings and objects.
IJsonObject - Interface in org.spincast.core.json
Represents a Json object "{}", and makes it easier to get its properties in a typed way.
IJsonObject.KeyNotFoundException - Exception in org.spincast.core.json
Exception thrown when a key is not found on a IJsonObject object.
IJsonObjectFactory - Interface in org.spincast.core.json
Factory to create IJsonObject and IJsonArray objects.
ILocaleResolver - Interface in org.spincast.core.locale
Component which finds the best Locale to use, using a cookie, a Accept-Language header or using a custom way.
init(ISpincastConfig, IRouter<R, W>) - Method in class org.spincast.core.routing.DefaultRouteParamAliasesBinder
Init : binds the aliases.
IPublicException - Interface in org.spincast.core.exceptions
An interface to be implemented by exceptions to indicate that their "message" can be displayed to the end user.
IRedirectRuleBuilder - Interface in org.spincast.core.routing
Builder to create a redirection rule.
IRedirectRuleBuilderFactory<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.routing
Factory to create IRedirectRuleBuilders.
IRequestContext<R extends IRequestContext<?>> - Interface in org.spincast.core.exchange
The base interface for a request context.
IRequestContextFactory<R extends IRequestContext<?>> - Interface in org.spincast.core.exchange
Assisted factory to create request context instances.
IRequestRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.exchange
Methods related to the current request.
IResponseRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.exchange
Methods to manipulate the response.
IResponseResetableException - Interface in org.spincast.core.exceptions
An interface for exceptions which allows them to control if the response should be reset (its buffer, headers, etc.) before running the "Exception" routing process.
IRoute<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
Represents a regular route and all its informations.
IRouteBuilder<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
Builder to create a route.
IRouteBuilderFactory<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.routing
Factory to create a route builder.
IRouteHandlerMatch<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
Represents a match found by the router.
IRouter<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.routing
The router.
IRoutingRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
Add-on to get information about the current routing process.
IRoutingResult<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
The result of the router, when asked to find matches for a request.
IS_EXCEPTION_HANDLING - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
If an "Exception" route is run, this variable will be set to true.
IS_NOT_FOUND_ROUTE - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
If a "Not Found" route is run, this variable will be set and its value will be true.
isAddDefaultTemplateVariablesFilter() - Method in interface org.spincast.core.config.ISpincastConfig
Should the GlobalTemplateVariablesAdderFilter be automatically added to all routes?
isAllowCookies() - Method in interface org.spincast.core.filters.ICorsFilterClient
Are cookies allowed in the cors request?
isAllowCookies() - Method in interface org.spincast.core.routing.IStaticResourceCorsConfig
Are cookies allowed?
isCachePrivate() - Method in interface org.spincast.core.routing.IStaticResourceCacheConfig
Should private be used when sending caching headers? more info...
isCachePrivateByDefault() - Method in class org.spincast.core.filters.SpincastFilters
 
isCanBeGenerated() - Method in interface org.spincast.core.routing.IStaticResource
Can this resource be generated?
isClasspath() - Method in interface org.spincast.core.routing.IStaticResource
Is the resource on the classpath?
isClosed() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Is the response closed? If so, nothing more can be sent...
isClosed() - Method in interface org.spincast.core.websocket.IWebsocketEndpointManager
Is this endpoint closed?
isContentTypeToSkipGziping(String) - Method in interface org.spincast.core.utils.ISpincastUtils
Should the specified Content-Type be gzipped?
isContentTypeToSkipGziping(String) - Method in class org.spincast.core.utils.SpincastUtils
 
isCorsOriginValid(ICorsFilterClient, Set<String>) - Method in class org.spincast.core.filters.CorsFilter
 
isCorsRequestedHeadersToBeSentValid(ICorsFilterClient, Set<String>) - Method in class org.spincast.core.filters.CorsFilter
 
isCorsRequestMethodHeaderValid(ICorsFilterClient, Set<HttpMethod>) - Method in class org.spincast.core.filters.CorsFilter
 
isDebugEnabled() - Method in interface org.spincast.core.config.ISpincastConfig
Let this to true on development environment, where errors can be publicly displayed, where cache can be disabled, etc.
isDefaultRouteCacheFilterPrivate() - Method in interface org.spincast.core.config.ISpincastConfig
When using the .cache() method on a route builder, is the cache private by default?
isDirResource() - Method in interface org.spincast.core.routing.IStaticResource
Is the resource a directory?
isDisableWriteToDiskDynamicStaticResource() - Method in interface org.spincast.core.config.ISpincastConfig
If true, the dynamic resources (static resource which have a generator in case they don't exist) won't be saved to disk.
isDiscard() - Method in interface org.spincast.core.cookies.ICookie
Is this cookie to be discarded?
IServer - Interface in org.spincast.core.server
The interface a HTTP server implementation must implement.
isExceptionRoute() - Method in interface org.spincast.core.routing.IRoutingRequestContextAddon
Are we currently on an "Exception" routing type?
isExpired() - Method in interface org.spincast.core.cookies.ICookie
Is this cookie expired?
isFileResource() - Method in interface org.spincast.core.routing.IStaticResource
Is the resource a file?
isFileSytem() - Method in interface org.spincast.core.routing.IStaticResource
Is the resource on the file system?
isForwarded() - Method in interface org.spincast.core.routing.IRoutingRequestContextAddon
Is the current route forwarded?
isHeadersSent() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Are the response headers sent? If this is the case, then the headers can't be changed anymore.
isHeadersSent() - Method in interface org.spincast.core.filters.ICorsFilterClient
Are the headers sent?
isHTMLShouldBeReturn() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Will return true if the request specifies that HTML is the most appropriate format to return.
isHttpOnly() - Method in interface org.spincast.core.cookies.ICookie
Is the cookie availableto the server and not to javascript?
isHttps() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Is the request a secure HTTPS one?
isJsonShouldBeReturn() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Will return true if the request specifies that Json is the most appropriate format to return.
isKeyExists(String) - Method in interface org.spincast.core.json.IJsonObject
Does the object contain the specified key?
isKeyExists(String) - Method in class org.spincast.core.json.JsonObject
 
isManagingEndpoint(String, IWebsocketController<?, ?>) - Method in interface org.spincast.core.websocket.IWebsocketEndpointToControllerManager
Is the specified controller currently the manager of the endpoint?
isManagingEndpoint(String, IWebsocketController<?, ?>) - Method in class org.spincast.core.websocket.WebsocketEndpointToControllerManager
 
isNotFoundRoute() - Method in interface org.spincast.core.routing.IRoutingRequestContextAddon
Are we currently on a "Not Found" routing type?
ISpincastConfig - Interface in org.spincast.core.config
The configurations required by Spincast.
ISpincastDictionary - Interface in org.spincast.core.config
Labels required by Spincast.
ISpincastFilters<R extends IRequestContext<?>> - Interface in org.spincast.core.filters
Some filters provided by Spincast.
ISpincastUtils - Interface in org.spincast.core.utils
Spincast utilities.
isPlainTextShouldBeReturn() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Will return true if the request specifies that plain-text is the most appropriate format to return.
isPreflightRequest(ICorsFilterClient) - Method in class org.spincast.core.filters.CorsFilter
 
isRedirectPermanently() - Method in exception org.spincast.core.exceptions.RedirectException
Is this a temporary or permanent redirection?
isResetResponse() - Method in interface org.spincast.core.exceptions.IResponseResetableException
Should the the response be reset before starting the "Exception" routing process?
isResetResponse() - Method in exception org.spincast.core.exceptions.ResponseResetableException
 
isResponseClosed(Object) - Method in interface org.spincast.core.server.IServer
Is the response closed?
isResponseHeadersSent(Object) - Method in interface org.spincast.core.server.IServer
Are the response headers sent?
isRoutesCaseSensitive() - Method in interface org.spincast.core.config.ISpincastConfig
Are the URLS case-sensitive or not, during the route matching process? The default value is false.
isSecure() - Method in interface org.spincast.core.cookies.ICookie
Is the "secure" feature on?
ISSLContextFactory - Interface in org.spincast.core.utils.ssl
 
IStaticResource<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
A static resource, from the classpath or the file system.
IStaticResourceBuilder<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
Builder to create static resources.
IStaticResourceBuilderFactory<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.routing
Factory to create static resources builders.
IStaticResourceCacheConfig - Interface in org.spincast.core.routing
Cache configurations available for a static resource.
IStaticResourceCorsConfig - Interface in org.spincast.core.routing
Cors configurations available for a static resource.
IStaticResourceFactory<R extends IRequestContext<?>> - Interface in org.spincast.core.routing
 
isWeak() - Method in interface org.spincast.core.routing.IETag
Is it weak?
isWildcard() - Method in interface org.spincast.core.routing.IETag
Is it a wildcard ETag?
isXMLShouldBeReturn() - Method in interface org.spincast.core.exchange.IRequestRequestContextAddon
Will return true if the request specifies that XML is the most appropriate format to return.
ITemplatingEngine - Interface in org.spincast.core.templating
Component that "evaluates" some templates or inline content, using some parameters.
ITemplatingRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.templating
Provides methods to deal with templating.
iterator() - Method in class org.spincast.core.json.JsonArray
 
iterator() - Method in class org.spincast.core.json.JsonObject
 
IVariablesRequestContextAddon<R extends IRequestContext<?>> - Interface in org.spincast.core.exchange
Methods to read and write request scoped variables.
IWebsocketConnectionConfig - Interface in org.spincast.core.websocket
 
IWebsocketContext<W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
The base interface for a WebSocket context.
IWebsocketContextFactory<W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
 
IWebsocketController<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
A controller for a WebSocket connection.
IWebsocketEndpointHandler - Interface in org.spincast.core.websocket
WebSocket endpoint handler.
IWebsocketEndpointHandlerFactory<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
 
IWebsocketEndpointManager - Interface in org.spincast.core.websocket
Manager for a WebSocket endpoint.
IWebsocketEndpointToControllerManager - Interface in org.spincast.core.websocket
 
IWebsocketEndpointWriter - Interface in org.spincast.core.websocket
Component to send WebSocket messages on an endpoint.
IWebsocketPeerManager - Interface in org.spincast.core.websocket
Component to manage a specific peer.
IWebsocketRoute<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
A WebSocket route.
IWebsocketRouteBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
Builder for WebSocket routes.
IWebsocketRouteBuilderFactory<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
Factory to create a WebSocket route builder.
IWebsocketRouteHandlerFactory<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Interface in org.spincast.core.websocket
 
IXmlManager - Interface in org.spincast.core.xml
Provides methods to work with XML strings and objects.

J

json() - Method in interface org.spincast.core.exchange.IRequestContext
Easy access to the IJsonManager, Json related methods.
json() - Method in class org.spincast.core.exchange.RequestContextBase
 
json() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds application/json as an accepted Content-Type.
json() - Method in interface org.spincast.core.websocket.IWebsocketContext
Easy access to the IJsonManager, Json related methods.
json() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
JsonArray - Class in org.spincast.core.json
IJsonArray implementation.
JsonArray(IJsonManager) - Constructor for class org.spincast.core.json.JsonArray
Constructor
JsonObject - Class in org.spincast.core.json
IJsonObject implementation.
JsonObject(IJsonManager) - Constructor for class org.spincast.core.json.JsonObject
 

K

KeyNotFoundException(String) - Constructor for exception org.spincast.core.json.IJsonObject.KeyNotFoundException
 

L

lastModified(Date) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
Specifies the last modification date of the resource.
lastResortExceptionHandling(Throwable, Throwable) - Method in class org.spincast.core.controllers.SpincastFrontController
Called when the default exception handler itself throws an exception...
logger - Variable in class org.spincast.core.controllers.SpincastFrontController
 
logger - Variable in class org.spincast.core.exchange.DefaultRequestContext
 
logger - Variable in class org.spincast.core.exchange.RequestContextBase
 
logger - Variable in class org.spincast.core.filters.CorsFilter
 
logger - Variable in class org.spincast.core.filters.SpincastFilters
 
logger - Variable in class org.spincast.core.guice.SpincastCoreGuiceModule
 
logger - Variable in class org.spincast.core.guice.SpincastRequestScope
 
logger - Variable in class org.spincast.core.json.JsonArray
 
logger - Variable in class org.spincast.core.json.JsonObject
 
logger - Static variable in class org.spincast.core.utils.SpincastStatics
 
logger - Variable in class org.spincast.core.utils.SpincastUtils
 
logger - Variable in class org.spincast.core.utils.ssl.SSLContextFactory
 
logger - Variable in class org.spincast.core.websocket.DefaultWebsocketContext
 
logger - Variable in class org.spincast.core.websocket.WebsocketContextBase
 
logger - Variable in class org.spincast.core.websocket.WebsocketEndpointHandler
 
logger - Variable in class org.spincast.core.websocket.WebsocketRouteHandler
 

M

MainArgs - Annotation Type in org.spincast.core.guice
Used to bind and inject the arguments passed to the "public static void main(String[] args)" method.
manageCancellationFromOnPeerPreConnect() - Method in class org.spincast.core.websocket.WebsocketRouteHandler
Managed a null returned by the onPeerPreConnect() method of the controller.
manageForwardRouteException(ForwardRouteException, R, IRoutingResult<R>) - Method in class org.spincast.core.controllers.SpincastFrontController
Manage a ForwardRouteException exception.
manageInterruptedException(Exception) - Method in class org.spincast.core.utils.SpincastStatics
Return null to continue the exception processing or an exception to be returned immediatly.
manageRedirectException(RedirectException, R, IRoutingResult<R>) - Method in class org.spincast.core.controllers.SpincastFrontController
Manage a RedirectException exception.
map(K, V) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a map.
map(K, V, K, V) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a map.
map(K, V, K, V, K, V) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a map.
map(K, V, K, V, K, V, K, V) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a map.
map(K, V, K, V, K, V, K, V, K, V) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a map.
mapInstance(K, V) - Method in class org.spincast.core.utils.SpincastStatics
 
mapInstance(K, V, K, V) - Method in class org.spincast.core.utils.SpincastStatics
 
mapInstance(K, V, K, V, K, V) - Method in class org.spincast.core.utils.SpincastStatics
 
mapInstance(K, V, K, V, K, V, K, V) - Method in class org.spincast.core.utils.SpincastStatics
 
mapInstance(K, V, K, V, K, V, K, V, K, V) - Method in class org.spincast.core.utils.SpincastStatics
 
matches(IETag) - Method in interface org.spincast.core.routing.IETag
Does the ETag strongly matches the other specified ETag?
matches(IETag, boolean) - Method in interface org.spincast.core.routing.IETag
Does the ETag strongly or weakly matches the other specified ETag?

N

noCache() - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
Sends "No Cache" headers so the resource is not cached at all by the client.
noCache() - Method in interface org.spincast.core.routing.IRouteBuilder
Automatically adds "no-cache" headers to the response.
NOT_FOUND_PUBLIC_MESSAGE - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
If a "Not Found" route is run because of a NotFoundException has being thrown, the exception message, if any, is public and will be added using this variable.
notFound() - Method in interface org.spincast.core.routing.IRouteBuilder
This route will be considered during a Not Found routing process.
notFound(IHandler<R>) - Method in interface org.spincast.core.routing.IRouter
Creates a route considered during an "Not Found" routing process.
notFound(String, IHandler<R>) - Method in interface org.spincast.core.routing.IRouter
Creates a route considered during an "Not Found" routing process.
NotFoundException - Exception in org.spincast.core.exceptions
Exception to throw to trigger the "Not Found" route.
NotFoundException() - Constructor for exception org.spincast.core.exceptions.NotFoundException
If not already flushed, the response will be reset before running the "Not Found" routing process.
NotFoundException(String) - Constructor for exception org.spincast.core.exceptions.NotFoundException
If not already flushed, the response will be reset before running the "Not Found" routing process.
NotFoundException(boolean) - Constructor for exception org.spincast.core.exceptions.NotFoundException
 
NotFoundException(String, boolean) - Constructor for exception org.spincast.core.exceptions.NotFoundException
 

O

onEndpointClosed(String) - Method in interface org.spincast.core.websocket.IWebsocketController
The endpoint is now closed.
onEndpointClosed() - Method in interface org.spincast.core.websocket.IWebsocketEndpointHandler
The endpoint is actually closed by the server.
onEndpointClosed() - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
onEndpointReady(IWebsocketEndpointManager) - Method in interface org.spincast.core.websocket.IWebsocketController
This method is called when a new endpoint is created and its manager is ready.
onPeerClosed(W) - Method in interface org.spincast.core.websocket.IWebsocketController
A peer closed the WebSocket connection.
onPeerClosed(String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointHandler
A peer closed its connection.
onPeerClosed(String) - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
onPeerConnected(W) - Method in interface org.spincast.core.websocket.IWebsocketController
A peer is connected on the WebSocket endpoint.
onPeerConnected(String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointHandler
Called when the connection is established with a peer.
onPeerConnected(String) - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
onPeerMessage(W, String) - Method in interface org.spincast.core.websocket.IWebsocketController
A Peer sent a String message.
onPeerMessage(W, byte[]) - Method in interface org.spincast.core.websocket.IWebsocketController
A peer sent a bytes[] message.
onPeerMessage(String, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointHandler
A String message arrives from a peer.
onPeerMessage(String, byte[]) - Method in interface org.spincast.core.websocket.IWebsocketEndpointHandler
A bytes messages arrives from a peer.
onPeerMessage(String, String) - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
onPeerMessage(String, byte[]) - Method in class org.spincast.core.websocket.WebsocketEndpointHandler
 
onPeerPreConnect(R) - Method in interface org.spincast.core.websocket.IWebsocketController
Called before the HTTP request is converted to a WebSocket connection.
OPTIONS() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds OPTIONS as a supported HTTP method.
OPTIONS(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a OPTIONS route.
org.spincast.core.config - package org.spincast.core.config
 
org.spincast.core.controllers - package org.spincast.core.controllers
 
org.spincast.core.cookies - package org.spincast.core.cookies
 
org.spincast.core.exceptions - package org.spincast.core.exceptions
 
org.spincast.core.exchange - package org.spincast.core.exchange
 
org.spincast.core.filters - package org.spincast.core.filters
 
org.spincast.core.guice - package org.spincast.core.guice
 
org.spincast.core.json - package org.spincast.core.json
 
org.spincast.core.locale - package org.spincast.core.locale
 
org.spincast.core.routing - package org.spincast.core.routing
 
org.spincast.core.server - package org.spincast.core.server
 
org.spincast.core.templating - package org.spincast.core.templating
 
org.spincast.core.utils - package org.spincast.core.utils
 
org.spincast.core.utils.ssl - package org.spincast.core.utils.ssl
 
org.spincast.core.websocket - package org.spincast.core.websocket
 
org.spincast.core.websocket.exceptions - package org.spincast.core.websocket.exceptions
 
org.spincast.core.xml - package org.spincast.core.xml
 
ORIGINAL_ROUTING_RESULT - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
This is going to be set to the original routing result, if an "Exception" route or a "Not Found" routing process is started.

P

parameterizeWithContextInterfaces(Class<T>) - Method in class org.spincast.core.guice.SpincastGuiceModuleBase
Get a version of the specified class parameterized with the request and Websocket context types.
parameterizeWithRequestContext(Class<T>) - Method in class org.spincast.core.guice.SpincastGuiceModuleBase
Get a version of the specified class parameterized with the request context type.
parameterizeWithWebsocketContext(Class<T>) - Method in class org.spincast.core.guice.SpincastGuiceModuleBase
Get a version of the specified class parameterized with the Websocket context type.
params(String, Object) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a Map<String, Object> map.
params(String, Object, String, Object) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a Map<String, Object> map.
params(String, Object, String, Object, String, Object) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a Map<String, Object> map.
params(String, Object, String, Object, String, Object, String, Object) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a Map<String, Object> map.
params(String, Object, String, Object, String, Object, String, Object, String, Object) - Static method in class org.spincast.core.utils.SpincastStatics
Creates a Map<String, Object> map.
parseDate(String) - Method in class org.spincast.core.json.JsonObject
 
parseDateFromJson(String) - Method in interface org.spincast.core.json.IJsonManager
Converts a Json date to a Java UTC date.
PATCH() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds PATCH as a supported HTTP method.
PATCH(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a PATCH route.
path(String) - Method in interface org.spincast.core.routing.IRouteBuilder
The path of the route.
path(String) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilder
The path that trigger the beginning of that HTTP to WebSocket connection.
pathAbsolute(String) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
The absolute path to the resource, on the file system.
pathRelative(String) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
The path to the resource, on the file system, relative to the temp Spincast directory, as returned by ISpincastConfig::getSpincastTempDir()
peerManager() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
permanently() - Method in interface org.spincast.core.routing.IRedirectRuleBuilder
The redirection will be permanent (301).
pos(int) - Method in interface org.spincast.core.routing.IRouteBuilder
The position of the handler.
POST() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds POST as a supported HTTP method.
POST(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a POST route.
prepareNotFoundRouting(Object, R) - Method in class org.spincast.core.controllers.SpincastFrontController
Prepares a direct Not Found routing.
prepareNotFoundRouting(Object, R, boolean) - Method in class org.spincast.core.controllers.SpincastFrontController
Prepares a direct Not Found routing.
PublicException - Exception in org.spincast.core.exceptions
 
PublicException() - Constructor for exception org.spincast.core.exceptions.PublicException
 
PublicException(String) - Constructor for exception org.spincast.core.exceptions.PublicException
 
PublicException(String, int) - Constructor for exception org.spincast.core.exceptions.PublicException
 
PublicException(String, boolean) - Constructor for exception org.spincast.core.exceptions.PublicException
 
PublicException(String, int, boolean) - Constructor for exception org.spincast.core.exceptions.PublicException
 
put(String, Object) - Method in interface org.spincast.core.json.IJsonObject
Adds a property to the object.
put(String, Object) - Method in class org.spincast.core.json.JsonObject
 
PUT() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds PUT as a supported HTTP method.
PUT(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a PUT route.

R

redirect(String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sets a redirection header.
redirect(String, int) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sets the redirection headers with a specified 3xx status code.
redirect(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a redirection rule.
RedirectException - Exception in org.spincast.core.exceptions
Exception that will immediately send redirection headers and will skip any remaining handlers.
RedirectException(String, boolean) - Constructor for exception org.spincast.core.exceptions.RedirectException
 
remove(String) - Method in interface org.spincast.core.exchange.IVariablesRequestContextAddon
Removes a request scoped variable.
remove(String) - Method in interface org.spincast.core.json.IJsonObject
Removes a property from the object.
remove(String) - Method in class org.spincast.core.json.JsonObject
 
removeAll() - Method in interface org.spincast.core.json.IJsonObject
Removes all properties from the object.
removeAll() - Method in class org.spincast.core.json.JsonObject
 
removeAllRoutes() - Method in interface org.spincast.core.routing.IRouter
Removes all routes.
removeAllStaticResourcesServed() - Method in interface org.spincast.core.server.IServer
Removes all static resources served directly by the server.
removeCacheBusterCodes(String) - Method in interface org.spincast.core.utils.ISpincastUtils
Removes the cache buster code occurences from the given text.
removeCacheBusterCodes(String) - Method in class org.spincast.core.utils.SpincastUtils
 
removeEndpointController(String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointToControllerManager
Removes the link between a WebSocket endpoint and a controller.
removeEndpointController(String) - Method in class org.spincast.core.websocket.WebsocketEndpointToControllerManager
 
removeHeader(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Removes an header by its name.
removeHttpAuthentication(String, String) - Method in interface org.spincast.core.server.IServer
Removes a user to an HTTP protected realm.
removeHttpAuthentication(String) - Method in interface org.spincast.core.server.IServer
Removes a user from all HTTP protected realms.
removeResponseHeader(Object, String) - Method in interface org.spincast.core.server.IServer
Removes a response header.
removeRoute(String) - Method in interface org.spincast.core.routing.IRouter
Removes a route using its routeId.
removeStaticResourcesServed(StaticResourceType, String) - Method in interface org.spincast.core.server.IServer
Removes a static resource served directly by the server.
request() - Method in interface org.spincast.core.exchange.IRequestContext
Request related methods.
request() - Method in class org.spincast.core.exchange.RequestContextBase
 
REQUEST - Static variable in interface org.spincast.core.guice.SpincastGuiceScopes
Instance of the Guice scope for a request.
requestContainsCookies() - Method in interface org.spincast.core.filters.ICorsFilterClient
DOes the request contain cookies?
RequestContextBase<R extends IRequestContext<R>> - Class in org.spincast.core.exchange
The base implementation for a request context object.
RequestContextBase(Object, RequestContextBaseDeps<R>) - Constructor for class org.spincast.core.exchange.RequestContextBase
Constructor
RequestContextBaseDeps<R extends IRequestContext<R>> - Class in org.spincast.core.exchange
A wrapper object for the dependencies required by RequestContextBase.
RequestContextBaseDeps(ILocaleResolver, IJsonManager, IXmlManager, Provider<ICookiesRequestContextAddon<R>>, Provider<IRequestRequestContextAddon<R>>, Provider<IRoutingRequestContextAddon<R>>, Provider<IResponseRequestContextAddon<R>>, Provider<IVariablesRequestContextAddon<R>>, Provider<ITemplatingRequestContextAddon<R>>, Provider<ICacheHeadersRequestContextAddon<R>>, Provider<Injector>) - Constructor for class org.spincast.core.exchange.RequestContextBaseDeps
Constructor
RequestContextType - Annotation Type in org.spincast.core.exchange
Used to bind and inject the request context type.
RequestScopedVariables() - Constructor for class org.spincast.core.config.SpincastConstants.RequestScopedVariables
 
resetBuffer() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Clears the buffer (the unsent buffer, of course).
resetCookies() - Method in interface org.spincast.core.cookies.ICookiesRequestContextAddon
Resets the current cookies to the original ones of the request.
resetEverything() - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Clears the buffer (the unsent buffer, of course), resets the cookies, the headers, the Content-Type and sets the status code back to 200.
resetEverything() - Method in interface org.spincast.core.filters.ICorsFilterClient
Resets the response.
resetResponse(R) - Method in class org.spincast.core.controllers.SpincastFrontController
 
response() - Method in interface org.spincast.core.exchange.IRequestContext
Response related methods.
response() - Method in class org.spincast.core.exchange.RequestContextBase
 
ResponseResetableException - Exception in org.spincast.core.exceptions
An exception which allows to control if the response should be reset (its buffer, headers, etc.) before running the "Exception" routing process.
ResponseResetableException() - Constructor for exception org.spincast.core.exceptions.ResponseResetableException
If not already flushed, the response will be reset before running the new route
ResponseResetableException(String) - Constructor for exception org.spincast.core.exceptions.ResponseResetableException
If not already flushed, the response will be reset before running the new route
ResponseResetableException(boolean) - Constructor for exception org.spincast.core.exceptions.ResponseResetableException
If not already flushed, the response will be reset before running the new route
ResponseResetableException(String, boolean) - Constructor for exception org.spincast.core.exceptions.ResponseResetableException
If not already flushed, the response will be reset before running the new route
route(R) - Method in interface org.spincast.core.routing.IRouter
Find the route to use to handle the current request.
route(R, RoutingType) - Method in interface org.spincast.core.routing.IRouter
Find the route to use to handle the current request, given the specified routing type.
ROUTE_FORWARDED_NBR - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
The number of time a request has been forwarded.
ROUTE_HANDLER_MATCH - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
The current route handler match.
route_notFound_default_message() - Method in interface org.spincast.core.config.ISpincastDictionary
The message to display if the default Not Found route is used.
routing() - Method in interface org.spincast.core.exchange.IRequestContext
Routing related methods.
routing() - Method in class org.spincast.core.exchange.RequestContextBase
 
ROUTING_RESULT - Static variable in class org.spincast.core.config.SpincastConstants.RequestScopedVariables
The current routing result.
RoutingType - Enum in org.spincast.core.routing
The possible types of a routing process.
runtimize(Exception) - Static method in class org.spincast.core.utils.SpincastStatics
 
runtimizePrivate(Exception) - Method in class org.spincast.core.utils.SpincastStatics
 

S

save(IHandler<R>) - Method in interface org.spincast.core.routing.IRouteBuilder
Creates the route and saves it to the router.
save() - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Saves the static resource route to the router.
save(IHandler<R>) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
Saves the static resource route.
save(IWebsocketController<R, W>) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilder
Saves the WebSocket route on the router.
saveGeneratedResource(R, String) - Method in interface org.spincast.core.filters.ISpincastFilters
Used by Spincast to save a "dynamic resource" once it is generated.
saveGeneratedResource(R, String) - Method in class org.spincast.core.filters.SpincastFilters
 
scope(Key<T>, Provider<T>) - Method in class org.spincast.core.guice.SpincastRequestScope
 
SEC_WEBSOCKET_ACCEPT - Static variable in class org.spincast.core.config.SpincastConstants.HttpHeadersExtra
 
SEC_WEBSOCKET_KEY - Static variable in class org.spincast.core.config.SpincastConstants.HttpHeadersExtra
 
SEC_WEBSOCKET_LOCATION - Static variable in class org.spincast.core.config.SpincastConstants.HttpHeadersExtra
 
SEC_WEBSOCKET_VERSION - Static variable in class org.spincast.core.config.SpincastConstants.HttpHeadersExtra
 
seed(Key<T>, T) - Method in class org.spincast.core.guice.SpincastRequestScope
 
seed(Class<T>, T) - Method in class org.spincast.core.guice.SpincastRequestScope
 
sendBytes(byte[]) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends some bytes, without flushing.
sendBytes(byte[], String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends some bytes using the specified Content-Type, without flushing.
sendBytes(byte[], String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends some bytes using the specified Content-Type and flushes, if specified.
sendCharacters(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String, using the encoding returned by getCharactersCharsetName, without flushing.
sendCharacters(String, String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String, using the encoding returned by getCharactersCharsetName and using the specified Content-Type, without flushing.
sendCharacters(String, String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String, using the encoding returned by getCharactersCharsetName and using the specified Content-Type.
sendErrorUsingBestMatchContentType(Object, String, Integer) - Method in class org.spincast.core.controllers.SpincastFrontController
Send an error to the client.
sendHtml(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String as text/html, UTF-8 encoded, without flushing.
sendHtml(String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String as text/html, UTF-8 encoded, and flushes, if specified.
sendHtmlParse(String, Map<String, Object>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Parses the given String using the ITemplatingEngine and the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.
sendHtmlParse(String, Map<String, Object>, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Parses the given String using the ITemplatingEngine and the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified.
sendHtmlTemplate(String, Map<String, Object>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.
sendHtmlTemplate(String, Map<String, Object>, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified.
sendHtmlTemplate(String, boolean, Map<String, Object>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, without flushing.
sendHtmlTemplate(String, boolean, Map<String, Object>, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the HTML template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result as text/html, UTF-8 encoded, and flushes, if specified.
sendJson(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a Json String using the application/json Content-Type, without flushing.
sendJson(String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a Json String using the application/json Content-Type, and flushes, if specified.
sendJsonObj(Object) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Serializes the object to Json and sends as application/json, without flushing.
sendJsonObj(Object, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Serializes the object to Json, sends as application/json, and flushes, if specified.
sendMessage(String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a String message to all peers of the endpoint.
sendMessage(String, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a String message to a specific peer.
sendMessage(Set<String>, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a String message to specific peers.
sendMessage(byte[]) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a byte array message to all peers of the endpoint.
sendMessage(String, byte[]) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a byte array message to a specific peer.
sendMessage(Set<String>, byte[]) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a byte array message to specific peers.
sendMessage(String) - Method in interface org.spincast.core.websocket.IWebsocketPeerManager
Sends a String message to the peer.
sendMessage(byte[]) - Method in interface org.spincast.core.websocket.IWebsocketPeerManager
Sends a byte array message to the peer.
sendMessageExcept(String, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a String message to all peers except the specified one.
sendMessageExcept(Set<String>, String) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a String message to all peers except the specified ones.
sendMessageExcept(String, byte[]) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a byte array message to all peers except the specified one.
sendMessageExcept(Set<String>, byte[]) - Method in interface org.spincast.core.websocket.IWebsocketEndpointWriter
Sends a byte array message to all peers except the specified ones.
sendMessageToCurrentPeer(String) - Method in interface org.spincast.core.websocket.IWebsocketContext
Sends a String message to the current peer.
sendMessageToCurrentPeer(byte[]) - Method in interface org.spincast.core.websocket.IWebsocketContext
Sends a byte array message to the current peer.
sendMessageToCurrentPeer(String) - Method in class org.spincast.core.websocket.WebsocketContextBase
 
sendMessageToCurrentPeer(byte[]) - Method in class org.spincast.core.websocket.WebsocketContextBase
 
sendParse(String, String, Map<String, Object>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Parses the given String using the ITemplatingEngine and the given parameters, then sends the result using the specified Content-Type, without flushing.
sendParse(String, String, Map<String, Object>, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Parses the given String using the ITemplatingEngine and the given parameters, then sends the result using the specified Content-Type, and flushes, if specified.
sendPlainText(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String as text/plain, UTF-8 encoded, without flushing.
sendPlainText(String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends a String as text/plain, UTF-8 encoded, and flushes, if specified.
sendTemplate(String, String, Map<String, Object>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, without flushing.
sendTemplate(String, String, Map<String, Object>, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, and flushes, if specified.
sendTemplate(String, boolean, String, Map<String, Object>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, without flushing.
sendTemplate(String, boolean, String, Map<String, Object>, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Finds the specified template using the ITemplatingEngine, evaluates it using the given parameters, then sends the result using the given contentType, and flushes, if specified.
sendXml(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends some XML using the application/xml Content-Type, without flushing.
sendXml(String, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sends some XML using the application/xml Content-Type, and flushes, if specified.
sendXmlObj(Object) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Serializes the object to XML and sends as application/xml, without flushing.
sendXmlObj(Object, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Serializes the object to XML, sends as application/xml, and flushes, if specified.
setCacheSeconds(int) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Adds caching headers.
setCacheSeconds(int, boolean) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Adds caching headers for the specified number of seconds.
setCharactersCharsetName(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sets the charset to use to convert characters to bytes.
setContentType(String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
The Content-Type header to use for the response.
setDomain(String) - Method in interface org.spincast.core.cookies.ICookie
Sets the cookie domain.
setExpires(Date) - Method in interface org.spincast.core.cookies.ICookie
Sets the date the cookie will expire.
setExpiresUsingMaxAge(Integer) - Method in interface org.spincast.core.cookies.ICookie
Sets the number of seconds for a cookie to live.
setGzipOption(GzipOption) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Enable or disable gzipping of the response.
setHeader(String, String) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Set the value to a response header.
setHeader(String, List<String>) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Set multiple values to a response header.
setHttpOnly(boolean) - Method in interface org.spincast.core.cookies.ICookie
Sets if the cookie is available only for to the server anbd not to javascript.
setInstance(SpincastStatics) - Static method in class org.spincast.core.utils.SpincastStatics
 
setPath(String) - Method in interface org.spincast.core.cookies.ICookie
Sets the cookie path.
setResponseHeader(Object, String, List<String>) - Method in interface org.spincast.core.server.IServer
Sets a response header.
setResponseHeaders(Object, Map<String, List<String>>) - Method in interface org.spincast.core.server.IServer
Sets the response headers.
setResponseStatusCode(Object, int) - Method in interface org.spincast.core.server.IServer
Sets the response status code.
setSecure(boolean) - Method in interface org.spincast.core.cookies.ICookie
Sets the "secure" feature on or off.
setStatusCode(int) - Method in interface org.spincast.core.exchange.IResponseRequestContextAddon
Sets the response's status code to use.
setStatusCode(int) - Method in interface org.spincast.core.filters.ICorsFilterClient
Sets the response's status code.
setValue(String) - Method in interface org.spincast.core.cookies.ICookie
Sets the cookie value.
size() - Method in interface org.spincast.core.json.IJsonArray
The array size.
size() - Method in class org.spincast.core.json.JsonArray
 
skip(String) - Method in interface org.spincast.core.routing.IRouteBuilder
Skip a "before" and "after" filter for this route.
skip(String) - Method in interface org.spincast.core.websocket.IWebsocketRouteBuilder
Skip a "before" filter for this WebSocket route ("after" filters are never run).
SkipRemainingHandlersException - Exception in org.spincast.core.exceptions
Exception that will simply stop the current routing process without starting any new one.
SkipRemainingHandlersException() - Constructor for exception org.spincast.core.exceptions.SkipRemainingHandlersException
 
SOME(Set<HttpMethod>) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds the specified HTTP methods as being supported.
SOME(HttpMethod...) - Method in interface org.spincast.core.routing.IRouteBuilder
Adds the specified HTTP methods as being supported.
SOME(String, Set<HttpMethod>) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a route matching the specified HTTP methods.
SOME(String, HttpMethod...) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a route matching the specified HTTP methods.
SpincastConstants - Class in org.spincast.core.config
Spincast constants.
SpincastConstants() - Constructor for class org.spincast.core.config.SpincastConstants
 
SpincastConstants.HttpHeadersExtra - Class in org.spincast.core.config
Some HTTP headers that are not defined in Guava's com.google.common.net.HttpHeaders
SpincastConstants.RequestScopedVariables - Class in org.spincast.core.config
Request scoped variables that Spincast may set.
SpincastCoreGuiceModule - Class in org.spincast.core.guice
The Spincast core Guice module.
SpincastCoreGuiceModule() - Constructor for class org.spincast.core.guice.SpincastCoreGuiceModule
Constructor
SpincastCoreGuiceModule(String[]) - Constructor for class org.spincast.core.guice.SpincastCoreGuiceModule
Constructor
SpincastFilters<R extends IRequestContext<?>> - Class in org.spincast.core.filters
Spincast filters implementations.
SpincastFilters(ICorsFilter, ISpincastConfig, IServer, ISpincastUtils) - Constructor for class org.spincast.core.filters.SpincastFilters
Constructor
SpincastFrontController<R extends IRequestContext<R>,W extends IWebsocketContext<?>> - Class in org.spincast.core.controllers
 
SpincastFrontController(IRouter<R, W>, ISpincastConfig, ISpincastDictionary, IServer, IRequestContextFactory<R>, SpincastRequestScope, Type, IJsonManager, IXmlManager) - Constructor for class org.spincast.core.controllers.SpincastFrontController
The constructor.
SpincastGuiceModuleBase - Class in org.spincast.core.guice
Base class for a Spincast Guice module.
SpincastGuiceModuleBase() - Constructor for class org.spincast.core.guice.SpincastGuiceModuleBase
 
SpincastGuiceScopes - Interface in org.spincast.core.guice
Custom Guice scoped defined by Spincast.
SpincastPluginGuiceModuleBase - Class in org.spincast.core.guice
Base class for Spincast plugins' Guice modules.
SpincastPluginGuiceModuleBase(Type, Type) - Constructor for class org.spincast.core.guice.SpincastPluginGuiceModuleBase
Constructor.
SpincastRequestScope - Class in org.spincast.core.guice
Guice scope for a request.
SpincastRequestScope() - Constructor for class org.spincast.core.guice.SpincastRequestScope
 
SpincastRequestScoped - Annotation Type in org.spincast.core.guice
Annotation for object that need to be request scoped.
SpincastStatics - Class in org.spincast.core.utils
Some very few static methods.
SpincastStatics() - Constructor for class org.spincast.core.utils.SpincastStatics
 
SpincastUtils - Class in org.spincast.core.utils
Implementations of the Spincast utilities.
SpincastUtils(ISpincastConfig) - Constructor for class org.spincast.core.utils.SpincastUtils
 
SSLContextFactory - Class in org.spincast.core.utils.ssl
 
SSLContextFactory() - Constructor for class org.spincast.core.utils.ssl.SSLContextFactory
 
start() - Method in interface org.spincast.core.server.IServer
Starts the server.
StaticResourceType - Enum in org.spincast.core.routing
The possible types of a static resource.
stop() - Method in interface org.spincast.core.server.IServer
Stops the server

T

templating() - Method in interface org.spincast.core.exchange.IRequestContext
Templating methods.
templating() - Method in class org.spincast.core.exchange.RequestContextBase
 
templating() - Method in interface org.spincast.core.websocket.IWebsocketContext
Easy access to the ITemplatingEngine, templating related methods.
templating() - Method in class org.spincast.core.websocket.WebsocketContextBase
 
temporarily() - Method in interface org.spincast.core.routing.IRedirectRuleBuilder
The redirection will be temporarily (302).
to(String) - Method in interface org.spincast.core.routing.IRedirectRuleBuilder
The new path or full URL to redirect to.
toJsonString() - Method in interface org.spincast.core.json.IJsonArray
The Json string representation of the array.
toJsonString(Object) - Method in interface org.spincast.core.json.IJsonManager
Gets the Json String representation of the specified object.
toJsonString(Object, boolean) - Method in interface org.spincast.core.json.IJsonManager
Gets the Json String representation of the specified object.
toJsonString() - Method in interface org.spincast.core.json.IJsonObject
Gets the Json String representation of the object.
toJsonString(boolean) - Method in interface org.spincast.core.json.IJsonObject
Gets the Json String representation of the object.
toJsonString() - Method in class org.spincast.core.json.JsonArray
 
toJsonString() - Method in class org.spincast.core.json.JsonObject
 
toJsonString(boolean) - Method in class org.spincast.core.json.JsonObject
 
toString() - Method in class org.spincast.core.exchange.RequestContextBase
 
toString() - Method in class org.spincast.core.json.JsonArray
 
toString() - Method in class org.spincast.core.json.JsonObject
 
toString() - Method in class org.spincast.core.utils.Bool
 
toXml(Object) - Method in interface org.spincast.core.xml.IXmlManager
Converts an object to XML.
toXml(Object, boolean) - Method in interface org.spincast.core.xml.IXmlManager
Converts an object to XML.
TRACE() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds TRACE as a supported HTTP method.
TRACE(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a TRACE route.
TRUE - Static variable in class org.spincast.core.utils.Bool
 

U

url(String) - Method in interface org.spincast.core.routing.IStaticResourceBuilder
The URL pointing to the resource.

V

validate(boolean) - Method in interface org.spincast.core.exchange.ICacheHeadersRequestContextAddon
Call this when you are done setting ETag and/or Last-Modified to validate them agains the headers sent by the client.
validateExchange(Object) - Method in class org.spincast.core.controllers.SpincastFrontController
Validate/modify the exchange before the handling.
validateRequirements() - Method in class org.spincast.core.guice.SpincastCoreGuiceModule
Validates the bindings that have to be done by other modules.
valueOf(String) - Static method in enum org.spincast.core.filters.CorsFilterResponse
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spincast.core.routing.HttpMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spincast.core.routing.RoutingType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spincast.core.routing.StaticResourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spincast.core.utils.ContentTypeDefaults
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spincast.core.utils.GzipOption
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.spincast.core.filters.CorsFilterResponse
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spincast.core.routing.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spincast.core.routing.RoutingType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spincast.core.routing.StaticResourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spincast.core.utils.ContentTypeDefaults
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spincast.core.utils.GzipOption
Returns an array containing the constants of this enum type, in the order they are declared.
variables() - Method in interface org.spincast.core.exchange.IRequestContext
Request scoped variables related methods.
variables() - Method in class org.spincast.core.exchange.RequestContextBase
 

W

websocket(String) - Method in interface org.spincast.core.routing.IRouter
Starts the creation of a Websocket route.
WEBSOCKET_V13_MAGIC_NUMBER - Static variable in class org.spincast.core.config.SpincastConstants
Do not change that, it is an official value.
websocketCloseEndpoint(String) - Method in interface org.spincast.core.server.IServer
Closes a Websocket endpoint.
websocketCloseEndpoint(String, int, String) - Method in interface org.spincast.core.server.IServer
Closes the entire Websocket endpoint.
websocketConnection(Object, String, String) - Method in interface org.spincast.core.server.IServer
Transforms the request to a peer Websocket connection on the endpoint 'endpointId'.
WebsocketContextBase<W extends IWebsocketContext<?>> - Class in org.spincast.core.websocket
The base implementation for a WebSocket context object.
WebsocketContextBase(String, String, IWebsocketPeerManager, WebsocketContextBaseDeps<W>) - Constructor for class org.spincast.core.websocket.WebsocketContextBase
Constructor
WebsocketContextBaseDeps<W extends IWebsocketContext<?>> - Class in org.spincast.core.websocket
A wrapper object for the dependencies required by WebsocketContextBase.
WebsocketContextBaseDeps(ILocaleResolver, IJsonManager, IXmlManager, ITemplatingEngine, Provider<Injector>) - Constructor for class org.spincast.core.websocket.WebsocketContextBaseDeps
Constructor
WebsocketContextType - Annotation Type in org.spincast.core.websocket
Used to bind and inject the WebSocket context type.
websocketCreateEndpoint(String, IWebsocketEndpointHandler) - Method in interface org.spincast.core.server.IServer
Creates a new Websocket endpoint.
WebsocketEndpointAlreadyManagedByAnotherControllerException - Exception in org.spincast.core.websocket.exceptions
Thrown if the WebSocket endpoint is already managed by another controller.
WebsocketEndpointAlreadyManagedByAnotherControllerException(String, String) - Constructor for exception org.spincast.core.websocket.exceptions.WebsocketEndpointAlreadyManagedByAnotherControllerException
 
WebsocketEndpointHandler<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Class in org.spincast.core.websocket
 
WebsocketEndpointHandler(String, IWebsocketController<R, W>, IWebsocketContextFactory<W>, IServer) - Constructor for class org.spincast.core.websocket.WebsocketEndpointHandler
Constructor
WebsocketEndpointToControllerManager - Class in org.spincast.core.websocket
 
WebsocketEndpointToControllerManager() - Constructor for class org.spincast.core.websocket.WebsocketEndpointToControllerManager
 
WebsocketRouteHandler<R extends IRequestContext<?>,W extends IWebsocketContext<?>> - Class in org.spincast.core.websocket
Route handler that manages the upgrade from a HTTP request to a WebSocket connection, once the potential "before" filters have been ran.
WebsocketRouteHandler(IWebsocketRoute<R, W>, IServer, IWebsocketEndpointHandlerFactory<R, W>, IWebsocketEndpointToControllerManager) - Constructor for class org.spincast.core.websocket.WebsocketRouteHandler
 

X

X_FORWARDED_HOST - Static variable in class org.spincast.core.config.SpincastConstants.HttpHeadersExtra
 
X_FORWARDED_PORT - Static variable in class org.spincast.core.config.SpincastConstants.HttpHeadersExtra
 
xml() - Method in interface org.spincast.core.exchange.IRequestContext
Easy access to the IXmlManager, XML related methods.
xml() - Method in class org.spincast.core.exchange.RequestContextBase
 
xml() - Method in interface org.spincast.core.routing.IRouteBuilder
Adds application/xml as an accepted Content-Type.
xml() - Method in interface org.spincast.core.websocket.IWebsocketContext
Easy access to the IXmlManager, XML related methods.
xml() - Method in class org.spincast.core.websocket.WebsocketContextBase
 

Z

zipDirectory(File, File, boolean) - Method in interface org.spincast.core.utils.ISpincastUtils
Zips a directory.
zipDirectory(File, File, boolean) - Method in class org.spincast.core.utils.SpincastUtils
 
zipExtract(File, File) - Method in interface org.spincast.core.utils.ISpincastUtils
Extracts a .zip file to the specified directory.
zipExtract(File, File) - Method in class org.spincast.core.utils.SpincastUtils
 
A B C D E F G H I J K L M N O P R S T U V W X Z 

Copyright © 2016. All rights reserved.