StaticClasspathFileHandler

Instance Constructors

new StaticClasspathFileHandler(roots: Seq[File], devMode: Boolean, classLoader: ClassLoader)

Type Members

case class NormalResolvedFile(file: File, expirationSeconds: Int) extends ResolvedFile with Product with Serializable

Attributes
protected
Definition Classes
StaticFileHandlerBase
case class RedirectResolvedFile(file: File, location: String) extends ResolvedFile with Product with Serializable

Attributes
protected
Definition Classes
StaticFileHandlerBase
sealed trait ResolvedFile extends AnyRef

Attributes
protected
Definition Classes
StaticFileHandlerBase

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def afterShutdown(): Unit

Called once web server shutdown is completed -- Should be idempotent
Called once web server shutdown is completed -- Should be idempotent

Definition Classes
RequestRouter
def afterStartup(): Unit

Called after the web server is running but before ping is enabled -- Should be idempotent
Called after the web server is running but before ping is enabled -- Should be idempotent

Definition Classes
RequestRouter
final def asInstanceOf[T0]: T0

Definition Classes
Any
def beforeShutdown(): Unit

Called when web server shutdown is requested but before actually shutting down -- Should be idempotent
Called when web server shutdown is requested but before actually shutting down -- Should be idempotent

Definition Classes
RequestRouter
def beforeStartup(): Unit

Called before the web server starts up -- Should be idempotent
Called before the web server starts up -- Should be idempotent

Definition Classes
RequestRouter
val classLoader: ClassLoader
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val devMode: Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getTimestampedPath(path: String): Option[String]

Given a file path return the timestamped version of the path if it exists
Given a file path return the timestamped version of the path if it exists
e.g. Given "/js/foo.js" return something like "/js/foo.1470690999454.js" (if the file exists)

Definition Classes
StaticFileHandlerBase
def handleFileSystemFile(request: Request, f: File, expirationSeconds: Int): Option[RequestHandler]

This can be called by handleNormal for when the File refers to an actual file on the file system
This can be called by handleNormal for when the File refers to an actual file on the file system

Attributes
protected
Definition Classes
StaticFileHandlerBase
def handleNormal(request: Request, f: File, expirationSeconds: Int): Option[RequestHandler]

Attributes
protected
Definition Classes
StaticClasspathFileHandler → StaticFileHandlerBase
final def isFileSystemDir(f: File): Boolean

Attributes
protected
Definition Classes
StaticFileHandlerBase
final def isFileSystemFile(f: File): Boolean

Attributes
protected
Definition Classes
StaticFileHandlerBase
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isValidDir(f: File): Boolean

Is this a valid directory that we should check for an index file?
Is this a valid directory that we should check for an index file?
Note: If you don't want to use index files then this can just return false for everything.

Attributes
protected
Definition Classes
StaticClasspathFileHandler → StaticFileHandlerBase
def isValidFile(f: File): Boolean

Is this a valid file we can serve?
Is this a valid file we can serve?

Attributes
protected
Definition Classes
StaticClasspathFileHandler → StaticFileHandlerBase
def lastModified(f: File): Long

Last modified timestamp for a file in milliseconds
Last modified timestamp for a file in milliseconds

Attributes
protected
Definition Classes
StaticClasspathFileHandler → StaticFileHandlerBase
lazy val logger: Logger

Attributes
protected
Definition Classes
Logging
final def lookup(request: Request): Option[RequestHandler]

Given a request lookup a RequestHandler that can satisfy it
Given a request lookup a RequestHandler that can satisfy it

Definition Classes
StaticFileHandlerBase → RequestRouter
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def orElse(that: RequestRouter): RequestRouter

If this router doesn't match the request then try that router
If this router doesn't match the request then try that router

Definition Classes
RequestRouter
val roots: Seq[File]

Root paths to search (in order) to find a matching file
Root paths to search (in order) to find a matching file

Definition Classes
StaticClasspathFileHandler → StaticFileHandlerBase
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def timestampedPath(path: String): String

Given a file path return the timestamped version of the path.
Given a file path return the timestamped version of the path.
Note: If the file doesn't exist then the path is returned unmodified
e.g. Given "/js/foo.js" return something like "/js/foo.1470690999454.js" (assuming the file exists)

Definition Classes
StaticFileHandlerBase
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withDefaultHandler(handler: RequestHandler): RequestRouter

If this request router does not match a request then send the request to the specified default handler
If this request router does not match a request then send the request to the specified default handler

Definition Classes
RequestRouter
final def withErrorHandler(handler: ErrorRequestHandler)(implicit ec: ExecutionContext): RequestRouter

If a RequestHandler throws an Exception then run this handler.
If a RequestHandler throws an Exception then run this handler. Useful for showing an Error Page when a request fails

Definition Classes
RequestRouter
final def withFilter(filter: Option[RequestFilter]): RequestRouter

Run any RequestHandlers returned by this RequestRouter through an optional RequestFilter
Run any RequestHandlers returned by this RequestRouter through an optional RequestFilter

Definition Classes
RequestRouter
final def withFilter(filter: RequestFilter): RequestRouter

Run any RequestHandlers returned by this RequestRouter through a RequestFilter
Run any RequestHandlers returned by this RequestRouter through a RequestFilter

Definition Classes
RequestRouter
final def withFilters(filters: TraversableOnce[RequestFilter]): RequestRouter

Run any RequestHandlers returned by this RequestRouter through a sequence of RequestFilter
Run any RequestHandlers returned by this RequestRouter through a sequence of RequestFilter

Definition Classes
RequestRouter

Related Docs: object StaticClasspathFileHandler | package server

final case class StaticClasspathFileHandler(roots: Seq[File], devMode: Boolean, classLoader: ClassLoader) extends StaticFileHandlerBase with Logging with Product with Serializable

Instance Constructors

new StaticClasspathFileHandler(roots: Seq[File], devMode: Boolean, classLoader: ClassLoader)

Type Members

case class NormalResolvedFile(file: File, expirationSeconds: Int) extends ResolvedFile with Product with Serializable

case class RedirectResolvedFile(file: File, location: String) extends ResolvedFile with Product with Serializable

sealed trait ResolvedFile extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def afterShutdown(): Unit

def afterStartup(): Unit

final def asInstanceOf[T0]: T0

def beforeShutdown(): Unit

def beforeStartup(): Unit

val classLoader: ClassLoader

def clone(): AnyRef

val devMode: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def getTimestampedPath(path: String): Option[String]

def handleFileSystemFile(request: Request, f: File, expirationSeconds: Int): Option[RequestHandler]

def handleNormal(request: Request, f: File, expirationSeconds: Int): Option[RequestHandler]

final def isFileSystemDir(f: File): Boolean

final def isFileSystemFile(f: File): Boolean

final def isInstanceOf[T0]: Boolean

def isValidDir(f: File): Boolean

def isValidFile(f: File): Boolean

def lastModified(f: File): Long

lazy val logger: Logger

final def lookup(request: Request): Option[RequestHandler]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def orElse(that: RequestRouter): RequestRouter

val roots: Seq[File]

final def synchronized[T0](arg0: ⇒ T0): T0

final def timestampedPath(path: String): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def withDefaultHandler(handler: RequestHandler): RequestRouter

final def withErrorHandler(handler: ErrorRequestHandler)(implicit ec: ExecutionContext): RequestRouter

final def withFilter(filter: Option[RequestFilter]): RequestRouter

final def withFilter(filter: RequestFilter): RequestRouter

final def withFilters(filters: TraversableOnce[RequestFilter]): RequestRouter

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Logging

Inherited from StaticFileHandlerBase

Inherited from RequestRouter

Inherited from AnyRef

Inherited from Any

Ungrouped