A B C D E F G H I L M N O P R S T W

A

about(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

addQuickStartToWebsite() - Method in class org.spincast.website.maven.SpincastMavenPreparePackage

Adds a zipped version of the Quick Start to the website.

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

The application's routes

AdminController - Class in org.spincast.website.controllers

Admin controller

AdminController(String[], IJsonManager, ISpincastUtils, INewsService, IAppConfig) - Constructor for class org.spincast.website.controllers.AdminController

App - Class in org.spincast.website

App(IServer, IAppConfig, IAppRouter, MainPagesController, ErrorController, FeedController, AdminController, DemosTutorialsController, DemoFormAuthController, DemoFormValidationController, ISpincastFilters<IAppRequestContext>, WebsocketsDemoEchoAllController) - Constructor for class org.spincast.website.App

APP_PROPERTIES_KEY_ADMIN_CREDENTIAL_KEYS - Static variable in class org.spincast.website.AppConfig

APP_PROPERTIES_KEY_SERVER_SCHEME_HOST_PORT - Static variable in class org.spincast.website.AppConfig

AppConfig - Class in org.spincast.website

We use the "spincast-plugins-config-properties-file" plugin, so we can override some configurations in an "app.properties" file.

AppConfig(ISpincastUtils, String[], ISpincastConfigPropsFileBasedConfig) - Constructor for class org.spincast.website.AppConfig

AppConfigPropsFileBasedConfig - Class in org.spincast.website

Custom configurations for the .properties file based config plugin.

AppConfigPropsFileBasedConfig() - Constructor for class org.spincast.website.AppConfigPropsFileBasedConfig

AppConstants - Class in org.spincast.website

AppConstants() - Constructor for class org.spincast.website.AppConstants

AppModule - Class in org.spincast.website.guice

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

AppPebbleExtension - Class in org.spincast.website.pebble

Custom Pebble extension.

AppPebbleExtension() - Constructor for class org.spincast.website.pebble.AppPebbleExtension

AppPebbleTemplatingEngineConfig - Class in org.spincast.website

Custom Pebble plugin configurations.

AppPebbleTemplatingEngineConfig(AppPebbleExtension, ISpincastConfig) - Constructor for class org.spincast.website.AppPebbleTemplatingEngineConfig

AppRequestContext - Class in org.spincast.website.exchange

Custom request context class

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

AppRouter - Class in org.spincast.website.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>".

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

B

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

We use our application config class instead of the default one for the ISpincastConfig interface.

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

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

C

cleanContent(String) - Method in class org.spincast.website.repositories.TemplateFilesRepository

community(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

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

configureLogback() - Method in class org.spincast.website.App

Configure Logback programatically.

copyJavadocsToWebsite() - Method in class org.spincast.website.maven.SpincastMavenPreparePackageRelease

Copies the Javadoc to the website

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

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

D

DemoFormAuthController - Class in org.spincast.website.controllers

Form authentication/Session demo controller

DemoFormAuthController() - Constructor for class org.spincast.website.controllers.DemoFormAuthController

DemoFormValidationController - Class in org.spincast.website.controllers

Form validation demo controller

DemoFormValidationController() - Constructor for class org.spincast.website.controllers.DemoFormValidationController

DemosTutorialsController - Class in org.spincast.website.controllers

Demos/Tutorials controller

DemosTutorialsController() - Constructor for class org.spincast.website.controllers.DemosTutorialsController

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

documentation(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

download(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

E

ErrorController - Class in org.spincast.website.controllers

ErrorController() - Constructor for class org.spincast.website.controllers.ErrorController

exceptionHandler(IAppRequestContext) - Method in class org.spincast.website.controllers.ErrorController

Exception handler

F

FeedController - Class in org.spincast.website.controllers

FeedController(INewsService, IAppConfig) - Constructor for class org.spincast.website.controllers.FeedController

Constructor

fullWebsite(IAppRequestContext) - Method in class org.spincast.website.controllers.DemosTutorialsController

G

generateAggregatedJavadoc() - Method in class org.spincast.website.maven.SpincastMavenPreparePackageRelease

Generates the aggregated Javadoc

generateFeed(String) - Method in class org.spincast.website.controllers.FeedController

generatePeerId() - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

getAdminController() - Method in class org.spincast.website.App

getAdminUsernamesPasswords() - Method in class org.spincast.website.AppConfig

getAdminUsernamesPasswords() - Method in interface org.spincast.website.IAppConfig

A list of username/password that allow administrative privileges.

getAppConfig() - Method in class org.spincast.website.controllers.AdminController

getAppConfig() - Method in class org.spincast.website.controllers.FeedController

getAppConfig() - Method in class org.spincast.website.controllers.MainPagesController

getAppConfig() - Method in class org.spincast.website.HttpAuthInit

getAppConfig() - Method in class org.spincast.website.repositories.TemplateFilesRepository

getAppConfig() - Method in class org.spincast.website.services.NewsService

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

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

The app's Guice modules to use.

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

getDemoFormAuthController() - Method in class org.spincast.website.App

getDemoFormValidationController() - Method in class org.spincast.website.App

getDemosTutorialsController() - Method in class org.spincast.website.App

getDescription() - Method in interface org.spincast.website.models.INewsEntry

The description of the news entry.

getDescription() - Method in class org.spincast.website.models.NewsEntry

getEndpointManager() - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

getErrorController() - Method in class org.spincast.website.App

getExtension() - Method in class org.spincast.website.AppPebbleTemplatingEngineConfig

getFeedController() - Method in class org.spincast.website.App

getFeedDateFormatter() - Method in class org.spincast.website.controllers.FeedController

getFeedNewsEntries() - Method in interface org.spincast.website.services.INewsService

Gets the news entries for the RSS feed.

getFeedNewsEntries() - Method in class org.spincast.website.services.NewsService

getFilters() - Method in class org.spincast.website.pebble.AppPebbleExtension

getFilters() - Method in class org.spincast.website.pebble.RemoveHtmlTagsPebbleFilter

getHttpServerPort() - Method in class org.spincast.website.AppConfig

We use "44420" as the default port for the website, if this port is not overriden in the .properties file.

getId() - Method in interface org.spincast.website.models.INewsEntry

The news entry's id

getId() - Method in class org.spincast.website.models.NewsEntry

getJavadocSourceGenerationDir() - Method in class org.spincast.website.maven.SpincastMavenPreparePackageRelease

getJsonManager() - Method in class org.spincast.website.controllers.AdminController

getJsonManager() - Method in class org.spincast.website.controllers.MainPagesController

getMainArgs() - Method in class org.spincast.website.controllers.AdminController

getMainArgs() - Method in class org.spincast.website.controllers.MainPagesController

getMainArgs() - Method in class org.spincast.website.maven.SpincastMavenScriptBase

getMavenInstallatinRoot() - Method in class org.spincast.website.maven.SpincastMavenScriptBase

getMetaProperties(String) - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNbrNewsEntriesOnNewsPage() - Method in class org.spincast.website.AppConfig

getNbrNewsEntriesOnNewsPage() - Method in interface org.spincast.website.IAppConfig

The number of news entries on a regular "News" listing page.

getNbrNewsEntriesPerFeedRequest() - Method in class org.spincast.website.AppConfig

getNbrNewsEntriesPerFeedRequest() - Method in interface org.spincast.website.IAppConfig

The number of news entries for a feed request.

getNbrNewsEntriesTotal() - Method in interface org.spincast.website.models.INewsEntriesAndTotalNbr

getNewsEntries() - Method in interface org.spincast.website.models.INewsEntriesAndTotalNbr

getNewsEntries(boolean) - Method in interface org.spincast.website.repositories.INewsRepository

Gets all the news entries.

getNewsEntries(int, int, boolean) - Method in interface org.spincast.website.repositories.INewsRepository

Gets news entries.

getNewsEntries(boolean) - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntries(int, int, boolean) - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntries(boolean) - Method in interface org.spincast.website.services.INewsService

Gets all the news entries.

getNewsEntries(int, int, boolean) - Method in interface org.spincast.website.services.INewsService

Gets news entries.

getNewsEntries(boolean) - Method in class org.spincast.website.services.NewsService

getNewsEntries(int, int, boolean) - Method in class org.spincast.website.services.NewsService

getNewsEntriesAndTotalNbr(int, int, boolean) - Method in interface org.spincast.website.repositories.INewsRepository

Gets news entries and the number total of entries in the data source.

getNewsEntriesAndTotalNbr(int, int, boolean) - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntriesById() - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntriesLocal() - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntriesTotalNumber() - Method in interface org.spincast.website.repositories.INewsRepository

Gets news entries number.

getNewsEntriesTotalNumber() - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntry(long) - Method in interface org.spincast.website.repositories.INewsRepository

Gets a specific news entry.

getNewsEntry(long) - Method in class org.spincast.website.repositories.TemplateFilesRepository

getNewsEntry(long) - Method in interface org.spincast.website.services.INewsService

Gets a specific news entry.

getNewsEntry(long) - Method in class org.spincast.website.services.NewsService

getNewsRepository() - Method in class org.spincast.website.services.NewsService

getNewsService() - Method in class org.spincast.website.controllers.AdminController

getNewsService() - Method in class org.spincast.website.controllers.FeedController

getNewsService() - Method in class org.spincast.website.controllers.MainPagesController

getPeerNamesAll() - Static method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

getPluginDocTemplatePath(String) - Method in class org.spincast.website.controllers.MainPagesController

Return the classpath path to the plugin documentation template or NULL if not found.

getProjectBaseDir() - Method in class org.spincast.website.maven.SpincastMavenScriptBase

getProjectBuildDir() - Method in class org.spincast.website.maven.SpincastMavenScriptBase

getProjectBuildOutputDir() - Method in class org.spincast.website.maven.SpincastMavenScriptBase

getProjectVersion() - Method in class org.spincast.website.maven.SpincastMavenPreparePackage

getPublishedDate() - Method in interface org.spincast.website.models.INewsEntry

The published date, format: "YYYY-MM-DD HH:mm"

getPublishedDate() - Method in class org.spincast.website.models.NewsEntry

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

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

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

getServer() - Method in class org.spincast.website.HttpAuthInit

getServerSchemeHostPort() - Method in class org.spincast.website.AppConfig

getServerSchemeHostPort() - Method in interface org.spincast.website.IAppConfig

The application can't know for sure by itself on which scheme/host/port it is served (for example : "https://www.example.com:8080").

getSpecificPathMainArgsPosition() - Method in class org.spincast.website.AppConfigPropsFileBasedConfig

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

getSpincastUtils() - Method in class org.spincast.website.controllers.AdminController

getSpincastUtils() - Method in class org.spincast.website.controllers.MainPagesController

getSpincastUtils() - Method in class org.spincast.website.maven.SpincastMavenPreparePackage

getTemplatingEngine() - Method in class org.spincast.website.repositories.TemplateFilesRepository

getTitle() - Method in interface org.spincast.website.models.INewsEntry

The title of the news entry.

getTitle() - Method in class org.spincast.website.models.NewsEntry

getWebsocketsDemoEchoAllController() - Method in class org.spincast.website.App

H

helloWorld(IAppRequestContext) - Method in class org.spincast.website.controllers.DemosTutorialsController

HTTP_AUTH_REALM_NAME_ADMIN - Static variable in class org.spincast.website.AppConstants

The name of the HTTP authentication realm for the "admin" section of the site.

HTTP_AUTH_REALM_NAME_EXAMPLE - Static variable in class org.spincast.website.AppConstants

The name of the HTTP authentication realm for the propected section example.

httpAuthentication(IAppRequestContext) - Method in class org.spincast.website.controllers.DemosTutorialsController

httpAuthenticationProtectedPage(IAppRequestContext) - Method in class org.spincast.website.controllers.DemosTutorialsController

HttpAuthInit - Class in org.spincast.website

Initilizes the HTTP authentication.

HttpAuthInit(IAppConfig, IServer) - Constructor for class org.spincast.website.HttpAuthInit

I

IAppConfig - Interface in org.spincast.website

IAppHandler - Interface in org.spincast.website.exchange

IAppRequestContext - Interface in org.spincast.website.exchange

IAppRouter - Interface in org.spincast.website.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, IDefaultWebsocketContext>".

index(IAppRequestContext) - Method in class org.spincast.website.controllers.AdminController

index(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

INewsEntriesAndTotalNbr - Interface in org.spincast.website.models

A set of news entries and the number total of entries in the repository.

INewsEntry - Interface in org.spincast.website.models

Spincast news entry.

INewsRepository - Interface in org.spincast.website.repositories

Repository for Spincast's news entry / blog entries.

INewsService - Interface in org.spincast.website.services

Spincast News service.

init() - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

init() - Method in class org.spincast.website.HttpAuthInit

init() - Method in class org.spincast.website.maven.SpincastMavenPreparePackage

init() - Method in class org.spincast.website.maven.SpincastMavenScriptBase

init() - Method in class org.spincast.website.repositories.TemplateFilesRepository

Init

L

log(String) - Method in class org.spincast.website.maven.SpincastMavenScriptBase

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

logger - Variable in class org.spincast.website.AppConfig

logger - Variable in class org.spincast.website.controllers.AdminController

logger - Variable in class org.spincast.website.controllers.DemoFormAuthController

logger - Variable in class org.spincast.website.controllers.DemoFormValidationController

logger - Variable in class org.spincast.website.controllers.DemosTutorialsController

logger - Variable in class org.spincast.website.controllers.ErrorController

logger - Variable in class org.spincast.website.controllers.FeedController

logger - Variable in class org.spincast.website.controllers.MainPagesController

logger - Variable in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

M

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

The entry point for the application.

main(String[]) - Static method in class org.spincast.website.maven.SpincastMavenPreparePackage

Main method

main(String[]) - Static method in class org.spincast.website.maven.SpincastMavenPreparePackageRelease

Main method

MainPagesController - Class in org.spincast.website.controllers

MainPagesController(String[], IJsonManager, ISpincastUtils, INewsService, IAppConfig) - Constructor for class org.spincast.website.controllers.MainPagesController

more(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

N

news(IAppRequestContext) - Method in class org.spincast.website.controllers.AdminController

news(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

newsEntry(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

NewsEntry - Class in org.spincast.website.models

Spincast news entry implementation.

NewsEntry(long, String, String, String) - Constructor for class org.spincast.website.models.NewsEntry

Constructor

NewsService - Class in org.spincast.website.services

Spincast news service implementation.

NewsService(INewsRepository, IAppConfig) - Constructor for class org.spincast.website.services.NewsService

Constructor

notFoundHandler(IAppRequestContext) - Method in class org.spincast.website.controllers.ErrorController

Not Found (404) handler

O

onEndpointClosed(String) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

onEndpointReady(IWebsocketEndpointManager) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

onPeerClosed(IDefaultWebsocketContext) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

onPeerConnected(IDefaultWebsocketContext) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

onPeerMessage(IDefaultWebsocketContext, String) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

onPeerMessage(IDefaultWebsocketContext, byte[]) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

onPeerPreConnect(IAppRequestContext) - Method in class org.spincast.website.controllers.WebsocketsDemoEchoAllController

org.spincast.website - package org.spincast.website

org.spincast.website.controllers - package org.spincast.website.controllers

org.spincast.website.exchange - package org.spincast.website.exchange

org.spincast.website.guice - package org.spincast.website.guice

org.spincast.website.maven - package org.spincast.website.maven

org.spincast.website.models - package org.spincast.website.models

org.spincast.website.pebble - package org.spincast.website.pebble

org.spincast.website.repositories - package org.spincast.website.repositories

org.spincast.website.services - package org.spincast.website.services

P

plugin(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

A Plugin documentation

plugins(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

presentation(IAppRequestContext) - Method in class org.spincast.website.controllers.MainPagesController

R

RC_VARIABLE_HTML_SECTION_CLASSES - Static variable in class org.spincast.website.AppConstants

Cookie name that can be used to save the user locale.

REMOVE_HTML_TAGS_FILTER_NAME - Static variable in class org.spincast.website.pebble.AppPebbleExtension

REMOVE_HTML_TAGS_FILTER_NAME - Static variable in class org.spincast.website.pebble.RemoveHtmlTagsPebbleFilter

RemoveHtmlTagsPebbleFilter - Class in org.spincast.website.pebble

Pebble filter to remove the HTML tags.

RemoveHtmlTagsPebbleFilter() - Constructor for class org.spincast.website.pebble.RemoveHtmlTagsPebbleFilter

rss(IAppRequestContext) - Method in class org.spincast.website.controllers.FeedController

S

sendException(String) - Method in class org.spincast.website.maven.SpincastMavenScriptBase

SpincastMavenPreparePackage - Class in org.spincast.website.maven

Script ran at the "prepare-package" phase, when building the website.

SpincastMavenPreparePackage(String[], ISpincastUtils) - Constructor for class org.spincast.website.maven.SpincastMavenPreparePackage

Constructor

SpincastMavenPreparePackageRelease - Class in org.spincast.website.maven

Script ran at the "prepare-package" phase, when building the website using the "release" profile.

SpincastMavenPreparePackageRelease(String[]) - Constructor for class org.spincast.website.maven.SpincastMavenPreparePackageRelease

Constructor

SpincastMavenScriptBase - Class in org.spincast.website.maven

Base class for scripts running durring a Maven building phase.

SpincastMavenScriptBase(String[]) - Constructor for class org.spincast.website.maven.SpincastMavenScriptBase

Constructor

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

Starts the application!

start() - Method in class org.spincast.website.maven.SpincastMavenPreparePackage

Starts the script

start() - Method in class org.spincast.website.maven.SpincastMavenPreparePackageRelease

Starts the script

T

TemplateFilesRepository - Class in org.spincast.website.repositories

Implementation of the News repository that takes the news entries from template files.

TemplateFilesRepository(IAppConfig, ITemplatingEngine) - Constructor for class org.spincast.website.repositories.TemplateFilesRepository

Constructor

todoList(IAppRequestContext) - Method in class org.spincast.website.controllers.DemosTutorialsController

toString() - Method in class org.spincast.website.models.NewsEntry

W

webSockets(IAppRequestContext) - Method in class org.spincast.website.controllers.DemosTutorialsController

WebsocketsDemoEchoAllController - Class in org.spincast.website.controllers

WebSockets demo controller

WebsocketsDemoEchoAllController() - Constructor for class org.spincast.website.controllers.WebsocketsDemoEchoAllController

A B C D E F G H I L M N O P R S T W