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

A

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

addGlobalTemplatingVariables(IAppRequestContext) - Method in class org.spincast.website.controllers.AppController

This will add some global variables that will be available to any templating engine evaluation.

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

App - Class in org.spincast.website

App(IServer, IAppConfig, IRouter<IAppRequestContext>, AppController, ErrorController, FeedController, ISpincastFilters<IAppRequestContext>) - Constructor for class org.spincast.website.App

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

AppController - Class in org.spincast.website.controllers

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

AppModule - Class in org.spincast.website.guice

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

AppRequestContext - Class in org.spincast.website.exchange

Custom request context class

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

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.

C

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

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

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

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

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

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

G

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

Generates the aggregated Javadoc

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

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

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

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

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

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

The description of the news entry.

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

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

Return an empty directory for the feeds.

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

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

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

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.AppController

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

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

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

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

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

The number of news entries per page.

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

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

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

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

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 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

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

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

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

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

Gets a specific news entry.

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.AppController

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

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

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

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.AppController

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

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

The title of the news entry.

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

H

HardcodedNewsRepository - Class in org.spincast.website.repositories

Hardcoded implementation of the News repository.

HardcodedNewsRepository(IAppConfig) - Constructor for class org.spincast.website.repositories.HardcodedNewsRepository

I

IAppConfig - Interface in org.spincast.website

IAppHandler - Interface in org.spincast.website.exchange

IAppRequestContext - Interface in org.spincast.website.exchange

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

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.maven.SpincastMavenPreparePackage

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

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.AppController

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

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

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

N

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

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

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) - Constructor for class org.spincast.website.services.NewsService

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

Not Found (404) handler

O

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.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.AppController

A Plugin documentation

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

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.

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

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

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