skinny.micro.base.ServletContextAccessor.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of skinny-micro_2.11 Show documentation
skinny-micro
The newest version!
package skinny.micro.base

import scala.language.reflectiveCalls
import scala.language.implicitConversions
import javax.servlet.ServletContext
import skinny.micro.context.ThinServletBaseConfig.BaseConfigType
import skinny.micro.implicits.{ RicherStringImplicits, ServletApiImplicits }
import skinny.micro.{ Initializable, SkinnyMicroBase }
import skinny.micro.context.{ InitParameters, SkinnyContext, ThinServletBaseConfig }
import skinny.micro.cookie.{ Cookie, CookieOptions }

/**
 * Provides accessor for ServletContext.
 */
trait ServletContextAccessor
  extends Initializable
  with ServletApiImplicits
  with RicherStringImplicits {

  import SkinnyMicroBase._

  private class NullConfig extends ThinServletBaseConfig {
    override def getServletContext(): ServletContext = null
    override def getInitParameter(name: String): String = null
    override def getInitParameterNames(): java.util.Enumeration[String] = null
    override def getBaseConfigType: BaseConfigType = BaseConfigType.Unknown
  }

  protected implicit def configWrapper(config: ThinServletBaseConfig) = new Config {

    override def context: ServletContext = config.getServletContext

    def initParameters = new InitParameters(config)

  }

  /**
   * The configuration, typically a ThinServletConfig or FilterConfig.
   */
  var config: ThinServletBaseConfig = new NullConfig {}

  /**
   * Initializes the kernel.  Used to provide context that is unavailable
   * when the instance is constructed, for example the servlet lifecycle.
   * Should set the `config` variable to the parameter.
   *
   * @param config the configuration.
   */
  def initialize(config: ThinServletBaseConfig): Unit = {
    this.config = config
    val path = contextPath match {
      case "" => "/" // The root servlet is "", but the root cookie path is "/"
      case p => p
    }
    servletContext(Cookie.CookieOptionsKey) = CookieOptions(path = path)
  }

  /**
   * The servlet context in which this kernel runs.
   */
  implicit def servletContext: ServletContext = config.context

  protected def serverAuthority(implicit ctx: SkinnyContext): String = {
    val p = serverPort(ctx)
    val h = serverHost(ctx)
    if (p == 80 || p == 443) h else h + ":" + p.toString
  }

  def serverHost(implicit ctx: SkinnyContext): String = {
    initParameter(HostNameKey).flatMap(_.blankOption) getOrElse ctx.request.getServerName
  }

  def serverPort(implicit ctx: SkinnyContext): Int = {
    initParameter(PortKey).flatMap(_.blankOption).map(_.toInt) getOrElse ctx.request.getServerPort
  }

  def contextPath: String = servletContext.contextPath

  /**
   * Gets an init parameter from the config.
   *
   * @param name the name of the key
   * @return an option containing the value of the parameter if defined, or
   *         `None` if the parameter is not set.
   */
  def initParameter(name: String): Option[String] = {
    config.initParameters.get(name) orElse {
      servletContext.initParameters.get(name)
    }
  }

}