Xitrum Guide

Download PDF

There are also Japanese, Korean, Russian, and Vietnamese versions.

• Introduction
  • Features
  • Contributors
• Tutorial
  • Create a new empty Xitrum project
  • Run
  • Import the project to Eclipse
  • Import the project to IntelliJ
  • Autoreload
    • Run with IDEs
    • Run with SBT
    • DCEVM
  • Ignore files
• Action and view
  • Normal action
  • FutureAction
  • Actor action
  • Respond to client
  • Respond template view file
    • Type casting currentAction
    • Mustache
    • CoffeeScript
  • Layout
    • Layout without separate file
    • Pass layout directly to respondView
  • Inline view
  • Render fragment
  • Respond view of other action
    • One action - multiple views
  • Component
• RESTful APIs
  • Route cache
  • Route order with first and last
  • Multiple paths for one action
  • Dot in route
  • Regex in route
  • Catch the rest of path
  • Link to an action
  • Redirect to another action
  • Forward to another action
  • Determine is the request is Ajax request
  • Anti-CSRF
  • antiCsrfInput and antiCsrfToken
  • SkipCsrfCheck
  • Manipulate collected routes
  • Getting entire request content
  • Documenting API with Swagger
• Template engines
  • Config template engine
  • Remove template engine
  • Create your own template engine
• Postbacks
  • Layout
  • Form
  • Non-form
  • Confirmation dialog
  • Extra params
  • Customize animation image while Ajax is loading
• XML
  • Unescape XML
  • Group XML elements
  • Render XHTML
• JavaScript and JSON
  • JavaScript
    • Add JavaScript fragments to view
    • Respond JavaScript directly without view
  • JSON
  • Plugin for Knockout.js
• Async response
  • WebSocket
  • SockJS
  • Chunked response
    • Forever iframe
    • Event Source
• Static files
  • Serve static files on disk
  • index.html fallback
  • 404 and 500
  • Serve resource files in classpath with WebJars convention
    • WebJars
    • Save resource file inside .jar file with WebJars convention
    • Respond a file in classpath
  • Client side cache with ETag and max-age
  • GZIP
  • Server side cache
• Serve flash socket policy file
• Scopes
  • Request
    • Kinds of params
    • Accesing params
    • “at”
    • “atJson”
    • RequestVar
  • Cookie
    • Allowed characters in cookie
  • Session
    • session.clear()
    • SessionVar
    • Session stores
    • Client side session store vs Server side session store
  • object vs. val
• Validation
  • Default validators
  • Write custom validators
• File upload
  • Ajax style upload
• Action filters
  • Before filters
  • After filters
  • Around filters
  • Execution order of filters
• Server-side cache
  • Cache page or action
  • Cache object
  • Remove cache
  • Config
  • How cache works
  • xitrum.util.LocalLruCache
• I18n
  • Write internationalized messages in source code
  • Extract messages to pot files
  • Where to save po files
  • Set language
  • Validation messages
  • Plural forms
  • Date and number format
• Log
  • Use object xitrum.Log directly
  • Use trait xitrum.Log
  • Don’t have to check log level before logging
  • Config log level, log output file etc.
  • Log to Fluentd
• Deploy to production server
  • Package directory
  • Customize xitrum-package
  • Connect a Scala console to a running JVM process
  • Install Oracle JDK on CentOS or Ubuntu manually
  • Start Xitrum in production mode when the system starts
  • Set up port forwarding
  • Tune Linux for massive connections
    • Increase open file limit
    • Tune kernel
    • Note about backlog
  • HAProxy tips
  • Nginx tips
  • Deploy to Heroku
    • Sign up and create repository
    • Create Procfile
    • Change port setting
    • See log level
    • Create alias for xitrum-package
    • Push to Heroku
• Clustering with Akka and Hazelcast
• Netty handlers
  • Netty handler architecture
  • Custom handlers
  • Xitrum default handlers
• Metrics
  • Collect metrics
    • Heap memory and CPU
    • Action metrics
    • Collect your custom metrics
  • Publish metrics
    • Xitrum default viewer
    • Jconsole viewer
    • Display metrics with custom viewer
    • Save metrics
• HOWTO
  • Basic authentication
    • Config basic authentication for the whole site
    • Add basic authentication to an action
  • Load config files
    • JSON file
    • Properties file
    • Typesafe config file
  • Serialize and deserialize
  • Encrypt data
  • Multiple sites at the same domain name
  • Convert Markdown text to HTML
  • Monitor file change
  • Temporary directory
  • Stream videos
• Dependencies
  • Dependency libraries
  • Related projects