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(IServer, IAppConfig, IAppRouter, IAppController, ISpincastFilters<IAppRequestContext>) - Constructor for class org.spincast.quickstart.App

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

AppConfig - Class in org.spincast.quickstart.config

Implementation of the application's custom configurations class.

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

AppController - Class in org.spincast.quickstart.controller

Implementation of an application controller.

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

AppModule - Class in org.spincast.quickstart.guice

Guice module for the application.

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

Constructor

AppRequestContext - Class in org.spincast.quickstart.exchange

Implementation of our custom request context type.

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

AppRouter - 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 "IAppRouter" instead of "IRouter<IAppRequestContext, IAppWebsocketContext>".

AppRouter(SpincastRouterDeps<IAppRequestContext, IAppWebsocketContext>) - Constructor for class org.spincast.quickstart.exchange.AppRouter

AppWebsocketContext - Class in org.spincast.quickstart.exchange

Implementation of our custom Websocket context type.

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

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 "ISpincastConfig" 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 class org.spincast.quickstart.exchange.AppRequestContext

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

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

A custom method example.

D

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

Displays a message when the application is started.

E

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

exception(IAppRequestContext) - Method in interface org.spincast.quickstart.controller.IAppController

Route handler for exceptions handling.

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 class org.spincast.quickstart.config.AppConfig

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

A custom configuration : return the application name.

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

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 class org.spincast.quickstart.exchange.AppWebsocketContext

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

A custom method example.

I

IAppConfig - Interface in org.spincast.quickstart.config

Application's custom configurations.

IAppController - Interface in org.spincast.quickstart.controller

An application controller.

IAppHandler - Interface in org.spincast.quickstart.exchange

The only purpose of this interface is to make it easier to declare an handler as "IAppHandler" instead of "IHandler<IAppRequestContext>".

IAppRequestContext - Interface in org.spincast.quickstart.exchange

Custom type which allows our application to extend the default request context and add custom methods and add-ons provided by plugins.

IAppRouter - 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 "IAppRouter" instead of "IRouter<IAppRequestContext, IAppWebsocketContext>".

IAppWebsocketContext - Interface in org.spincast.quickstart.exchange

Custom type which allows our application to extend the default Websocket context and add custom methods and add-ons provided by plugins.

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

indexPage(IAppRequestContext) - Method in interface org.spincast.quickstart.controller.IAppController

Route handler for the "/" index page.

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(IAppRequestContext) - Method in class org.spincast.quickstart.controller.AppController

notFound(IAppRequestContext) - Method in interface org.spincast.quickstart.controller.IAppController

Route handler for a "Not Found" request.

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(IAppRequestContext) - Method in class org.spincast.quickstart.controller.AppController

sumRoute(IAppRequestContext) - Method in interface org.spincast.quickstart.controller.IAppController

Route handler for the "/sum" route.

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