org.spincast.website.App Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation
Show all versions of spincast-website Show documentation
Source code for the https://www.spincast.org website.
package org.spincast.website;
import java.io.File;
import java.io.InputStream;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.spincast.core.filters.ISpincastFilters;
import org.spincast.core.server.IServer;
import org.spincast.core.utils.SpincastStatics;
import org.spincast.shaded.org.apache.commons.io.FileUtils;
import org.spincast.website.controllers.AdminController;
import org.spincast.website.controllers.AppController;
import org.spincast.website.controllers.ErrorController;
import org.spincast.website.controllers.FeedController;
import org.spincast.website.controllers.ShowcaseController;
import org.spincast.website.controllers.ShowcaseWebsocketEchoAllController;
import org.spincast.website.exchange.IAppRequestContext;
import org.spincast.website.exchange.IAppRouter;
import org.spincast.website.filters.GlobalTemplateVariablesAdderFilter;
import org.spincast.website.guice.AppModule;
import com.google.common.collect.Lists;
import com.google.inject.Guice;
import com.google.inject.Inject;
import com.google.inject.Injector;
import com.google.inject.Module;
import com.google.inject.util.Modules;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
public class App {
protected final Logger logger = LoggerFactory.getLogger(App.class);
/**
* The entry point for the application.
*/
public static void main(String[] args) {
createApp(args, null);
}
/**
* Creates an App instance using the given
* parameters, an overriding module, and returns the
* Guice injector.
*
* @param overridingModule Mostly useful for the integration tests. Those
* can override some bindings by specifying this overriding module.
*/
public static Injector createApp(String[] args, Module overridingModule) {
if(args == null) {
args = new String[]{};
}
//==========================================
// Should we override the base app modules
// with an overring module?
//==========================================
Injector guice = null;
if(overridingModule != null) {
guice = Guice.createInjector(Modules.override(getAppModules(args))
.with(overridingModule));
} else {
guice = Guice.createInjector(getAppModules(args));
}
App website = guice.getInstance(App.class);
website.start();
return guice;
}
/**
* The app's Guice modules to use.
*/
protected static List getAppModules(String[] args) {
return Lists.newArrayList(new AppModule(args));
}
//==========================================
// The application
//==========================================
private final IServer server;
private final IAppConfig appConfig;
private final IAppRouter router;
private final AppController appController;
private final ErrorController errorController;
private final FeedController feedController;
private final AdminController adminController;
private final ShowcaseController showcaseController;
private final ISpincastFilters spincastFilters;
private final GlobalTemplateVariablesAdderFilter globalTemplateVariablesAdderFilter;
private final ShowcaseWebsocketEchoAllController showcaseWebsocketEchoAllController;
@Inject
public App(IServer server,
IAppConfig config,
IAppRouter router,
AppController appController,
ErrorController errorController,
FeedController feedController,
AdminController adminController,
ShowcaseController showcaseController,
ISpincastFilters spincastFilters,
GlobalTemplateVariablesAdderFilter globalTemplateVariablesAdderFilter,
ShowcaseWebsocketEchoAllController showcaseWebsocketEchoAllController) {
this.server = server;
this.appConfig = config;
this.router = router;
this.appController = appController;
this.errorController = errorController;
this.feedController = feedController;
this.adminController = adminController;
this.showcaseController = showcaseController;
this.spincastFilters = spincastFilters;
this.globalTemplateVariablesAdderFilter = globalTemplateVariablesAdderFilter;
this.showcaseWebsocketEchoAllController = showcaseWebsocketEchoAllController;
}
protected IServer getServer() {
return this.server;
}
protected IAppConfig getConfig() {
return this.appConfig;
}
protected IAppRouter getRouter() {
return this.router;
}
protected AppController getAppController() {
return this.appController;
}
protected ErrorController getErrorController() {
return this.errorController;
}
protected FeedController getFeedController() {
return this.feedController;
}
protected AdminController getAdminController() {
return this.adminController;
}
protected ShowcaseController getShowcaseController() {
return this.showcaseController;
}
protected ISpincastFilters getSpincastFilters() {
return this.spincastFilters;
}
protected GlobalTemplateVariablesAdderFilter getGlobalTemplateVariablesAdderFilter() {
return this.globalTemplateVariablesAdderFilter;
}
protected ShowcaseWebsocketEchoAllController getShowcaseWebsocketEchoAllController() {
return this.showcaseWebsocketEchoAllController;
}
/**
* Starts the application!
*/
public void start() {
configureLogback();
addRoutes();
getServer().start();
displayStartedMessage();
}
/**
* Configure Logback programatically. This is
* the easiest way to have different logging
* behavior depending on the environment and
* using injected config!
*/
protected void configureLogback() {
try {
String logbackFilePath = "conf/logback.prod.xml";
if(getConfig().isDebugEnabled()) {
logbackFilePath = "conf/logback.debug.xml";
}
InputStream logbackFileIn = this.getClass().getClassLoader().getResourceAsStream(logbackFilePath);
if(logbackFileIn == null) {
throw new RuntimeException("Logback file not found on the classpath : " + logbackFilePath);
}
LoggerContext context = (LoggerContext)LoggerFactory.getILoggerFactory();
JoranConfigurator configurator = new JoranConfigurator();
configurator.setContext(context);
context.reset();
configurator.doConfigure(logbackFileIn);
} catch(Exception ex) {
throw SpincastStatics.runtimize(ex);
}
}
protected void displayStartedMessage() {
System.out.println();
System.out.println("====================================================");
if(getConfig().getHttpServerPort() > 0) {
System.out.println("Spincast HTTP website started on port " + getConfig().getHttpServerPort());
}
if(getConfig().getHttpsServerPort() > 0) {
System.out.println("Spincast HTTPS website started on port " + getConfig().getHttpsServerPort());
}
System.out.println("Environment : " + getConfig().getEnvironmentName());
System.out.println("Debug enabled? " + getConfig().isDebugEnabled());
System.out.println("====================================================");
System.out.println();
}
/**
* Return an empty directory for the feeds.
*/
protected File getEmptyFeedDir() {
try {
File feedDir = new File(getConfig().getSpincastWritableDir().getAbsolutePath() + "/feeds");
FileUtils.deleteDirectory(feedDir);
boolean result = feedDir.mkdirs();
if(!result) {
throw new RuntimeException("Unable to create the feed directory: " + feedDir.getAbsolutePath());
}
return feedDir;
} catch(Exception ex) {
throw SpincastStatics.runtimize(ex);
}
}
/**
* The application's routes
*/
protected void addRoutes() {
IAppRouter router = getRouter();
AppController appCtl = getAppController();
//==========================================
// Public resources
//==========================================
router.dir("/public").classpath("/public").save();
router.file("/favicon.ico").classpath("/public/favicon.ico").save();
router.file("/robots.txt").classpath("/public/robots.txt").save();
router.file("/humans.txt").classpath("/public/humans.txt").save();
router.file("/browserconfig.xml").classpath("/public/browserconfig.xml").save();
router.file("/apple-touch-icon.png").classpath("/public/apple-touch-icon.png").save();
router.file("/tile-wide.png").classpath("/public/tile-wide.png").save();
router.file("/tile.png").classpath("/public/tile.png").save();
//==========================================
// Add some security headers.
//==========================================
router.before(getSpincastFilters()::addSecurityHeaders);
//==========================================
// Filter that will add some global variables that will be
// available to any following templating engine evaluation.
//==========================================
router.before(getGlobalTemplateVariablesAdderFilter()::apply);
//==========================================
// Not Found (404) handler
//==========================================
router.notFound(getErrorController()::notFoundHandler);
//==========================================
// Exception handler
//==========================================
router.exception(getErrorController()::exceptionHandler);
//==========================================
// News Feed, as a dynamic resouce
//==========================================
File feedDir = getEmptyFeedDir();
router.file("/rss").fileSystem(feedDir + "/rss.xml").save(getFeedController()::rss);
//==========================================
// Protected area example
//==========================================
router.httpAuth("/protected_example", AppConstants.HTTP_AUTH_REALM_NAME_EXAMPLE);
router.GET("/protected_example").save(getAdminController()::example);
//==========================================
// Admin - protected area
//==========================================
router.httpAuth("/admin", AppConstants.HTTP_AUTH_REALM_NAME_ADMIN);
router.GET("/admin").save(getAdminController()::index);
router.GET("/admin/news").save(getAdminController()::news);
//==========================================
// Showcase - Websockets
//==========================================
router.GET("/showcase/websockets/echo-all").save(getShowcaseController()::websockets);
router.websocket("/showcase/websockets/echo-all-endpoint").save(getShowcaseWebsocketEchoAllController());
//==========================================
// Pages
//==========================================
router.GET("/").save(appCtl::index);
router.GET("/news").save(appCtl::news);
router.GET("/news/${newsId:}").save(appCtl::newsEntry);
router.GET("/documentation").save(appCtl::documentation);
router.GET("/download").save(appCtl::download);
router.GET("/plugins").save(appCtl::plugins);
router.GET("/community").save(appCtl::community);
router.GET("/about").save(appCtl::about);
router.GET("/plugins/${pluginName}").save(appCtl::plugin);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy