A B C D E G H I L M N O S

A

addRoutes() - Method in class org.spincast.quickstart.App

Adds the application routes.

App - Class in org.spincast.quickstart

The main class of the application.

App(Server, AppConfig, AppRouter, AppController, SpincastFilters<AppRequestContext>) - Constructor for class org.spincast.quickstart.App

The application constructor that Guice will call with the required dependencies.

AppConfig - Interface in org.spincast.quickstart.config

Application's custom configurations.

AppConfigDefault - Class in org.spincast.quickstart.config

Implementation of the application's custom configurations class.

AppConfigDefault() - Constructor for class org.spincast.quickstart.config.AppConfigDefault

AppController - Class in org.spincast.quickstart.controller

The application controller.

AppController(AppConfig) - Constructor for class org.spincast.quickstart.controller.AppController

AppHandler - Interface in org.spincast.quickstart.exchange

The only purpose of this interface is to make it easier to declare a Route Handler as "AppHandler" instead of "Handler<AppRequestContext>".

AppModule - Class in org.spincast.quickstart.guice

Guice module for the application.

AppModule(String[]) - Constructor for class org.spincast.quickstart.guice.AppModule

AppRequestContext - Interface in org.spincast.quickstart.exchange

Custom type which allows our application to extend the default Request Context.

AppRequestContextDefault - Class in org.spincast.quickstart.exchange

Implementation of our custom Request Context type.

AppRequestContextDefault(Object, RequestContextBaseDeps<AppRequestContext>) - Constructor for class org.spincast.quickstart.exchange.AppRequestContextDefault

AppRouter - Interface in org.spincast.quickstart.exchange

The only purpose of this interface is to make it easier to inject the application specific Router by using "AppRouter" instead of "Router<AppRequestContext, AppWebsocketContext>".

AppRouterDefault - Class in org.spincast.quickstart.exchange

The only purpose of this class is to make it easier to inject the application specific Router by using "AppRouter" instead of "Router<AppRequestContext, AppWebsocketContext>".

AppRouterDefault(SpincastRouterDeps<AppRequestContext, AppWebsocketContext>) - Constructor for class org.spincast.quickstart.exchange.AppRouterDefault

AppWebsocketContext - Interface in org.spincast.quickstart.exchange

Custom type which allows our application to extend the default Websocket Context.

AppWebsocketContextDefault - Class in org.spincast.quickstart.exchange

Implementation of our custom Websocket Context type.

AppWebsocketContextDefault(String, String, WebsocketPeerManager, WebsocketContextBaseDeps<AppWebsocketContext>) - Constructor for class org.spincast.quickstart.exchange.AppWebsocketContextDefault

B

bindConfigPlugin() - Method in class org.spincast.quickstart.guice.AppModule

Instead of installing the default "spincast-default-plugin" plugin, which only provides hardcoded values for the Spincast configurations, we directly bind the required "SpincastConfig" component to our custom implementation class.

bindRoutingPlugin() - Method in class org.spincast.quickstart.guice.AppModule

Inline, we override the Router implementation bound by the "spincast-routing" plugin, so our custom class is used.

C

configure() - Method in class org.spincast.quickstart.guice.AppModule

createApp(String[], Module) - Static method in class org.spincast.quickstart.App

Creates an App instance using the given parameters, an overriding module, and returns the Guice injector.

customGreetingMethod() - Method in interface org.spincast.quickstart.exchange.AppRequestContext

A custom method example.

customGreetingMethod() - Method in class org.spincast.quickstart.exchange.AppRequestContextDefault

Our simple example will take a "name" parameter from the path ("/greet/${name}" for example) and will output a greeting message.

D

displayStartedMessage() - Method in class org.spincast.quickstart.App

Displays a message when the application is started.

E

exception(AppRequestContext) - Method in class org.spincast.quickstart.controller.AppController

Route Handler to manage exceptions

G

getAppConfig() - Method in class org.spincast.quickstart.controller.AppController

getAppController() - Method in class org.spincast.quickstart.App

getAppModules(String[]) - Static method in class org.spincast.quickstart.App

The app's Guice modules to use.

getAppName() - Method in interface org.spincast.quickstart.config.AppConfig

A custom configuration : return the application name.

getAppName() - Method in class org.spincast.quickstart.config.AppConfigDefault

getConfig() - Method in class org.spincast.quickstart.App

getPublicServerSchemeHostPort() - Method in class org.spincast.quickstart.config.AppConfigDefault

getRequestContextImplementationClass() - Method in class org.spincast.quickstart.guice.AppModule

Tells Spincast to use our custom Request Context type instead of the default one.

getRouter() - Method in class org.spincast.quickstart.App

getServer() - Method in class org.spincast.quickstart.App

getSpincastFilters() - Method in class org.spincast.quickstart.App

getWebsocketContextImplementationClass() - Method in class org.spincast.quickstart.guice.AppModule

Tells Spincast to use our custom Websocket Context type instead of the default one.

H

helloCurrentPeer() - Method in interface org.spincast.quickstart.exchange.AppWebsocketContext

A custom method example.

helloCurrentPeer() - Method in class org.spincast.quickstart.exchange.AppWebsocketContextDefault

I

indexPage(AppRequestContext) - Method in class org.spincast.quickstart.controller.AppController

Index page handler

L

logger - Variable in class org.spincast.quickstart.App

M

main(String[]) - Static method in class org.spincast.quickstart.App

The entry point for the application.

N

notFound(AppRequestContext) - Method in class org.spincast.quickstart.controller.AppController

Route Handler to manage 404

O

org.spincast.quickstart - package org.spincast.quickstart

org.spincast.quickstart.config - package org.spincast.quickstart.config

org.spincast.quickstart.controller - package org.spincast.quickstart.controller

org.spincast.quickstart.exchange - package org.spincast.quickstart.exchange

org.spincast.quickstart.guice - package org.spincast.quickstart.guice

S

start() - Method in class org.spincast.quickstart.App

Once the application instance is created by Guice, start() is called and the real work begins!

sumRoute(AppRequestContext) - Method in class org.spincast.quickstart.controller.AppController

/sum route handler

A B C D E G H I L M N O S