org.mashupbots.socko.processors

StaticFileRequest

case class StaticFileRequest (context: HttpRequestProcessingContext, rootFileDir: File, file: File, tempDir: File, browserCacheTimeoutSeconds: Int, fileLastModifiedCacheTimeoutSeconds: Int) extends Product with Serializable

Message to be sent to StaticFileProcessor for it to download the specified file

context

HTTP Request context

rootFileDir

Root directory from which files will be served. file must be present under this directory; if not a 404 Not Found is returned. This is used to enforce security to make sure that only intended files can be downloaded.

file

File to download

tempDir

Temporary directory where compressed version of files can be stored

browserCacheTimeoutSeconds

Number of seconds to cache the file in the browser. Defaults to 1 hour.

fileLastModifiedCacheTimeoutSeconds

Number of seconds to cache a file's last modified timestamp. Defaults to 5 minutes.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. StaticFileRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StaticFileRequest (context: HttpRequestProcessingContext, rootFileDir: File, file: File, tempDir: File, browserCacheTimeoutSeconds: Int, fileLastModifiedCacheTimeoutSeconds: Int)

    context

    HTTP Request context

    rootFileDir

    Root directory from which files will be served. file must be present under this directory; if not a 404 Not Found is returned. This is used to enforce security to make sure that only intended files can be downloaded.

    file

    File to download

    tempDir

    Temporary directory where compressed version of files can be stored

    browserCacheTimeoutSeconds

    Number of seconds to cache the file in the browser. Defaults to 1 hour.

    fileLastModifiedCacheTimeoutSeconds

    Number of seconds to cache a file's last modified timestamp. Defaults to 5 minutes.

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. val browserCacheTimeoutSeconds : Int

    Number of seconds to cache the file in the browser.

    Number of seconds to cache the file in the browser. Defaults to 1 hour.

  8. def canEqual (arg0: Any): Boolean

    Definition Classes
    StaticFileRequest → Equals

  9. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  10. val context : HttpRequestProcessingContext

    HTTP Request context

  11. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  12. def equals (arg0: Any): Boolean

    Definition Classes
    StaticFileRequest → Equals → AnyRef → Any

  13. val file : File

    File to download

  14. val fileLastModifiedCacheTimeoutSeconds : Int

    Number of seconds to cache a file's last modified timestamp.

    Number of seconds to cache a file's last modified timestamp. Defaults to 5 minutes.

  15. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  16. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  17. def hashCode (): Int

    Definition Classes
    StaticFileRequest → AnyRef → Any

  18. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  19. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  20. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  21. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  22. def productArity : Int

    Definition Classes
    StaticFileRequest → Product

  23. def productElement (arg0: Int): Any

    Definition Classes
    StaticFileRequest → Product

  24. def productIterator : Iterator[Any]

    Definition Classes
    Product

  25. def productPrefix : String

    Definition Classes
    StaticFileRequest → Product

  26. val rootFileDir : File

    Root directory from which files will be served.

    Root directory from which files will be served. file must be present under this directory; if not a 404 Not Found is returned. This is used to enforce security to make sure that only intended files can be downloaded.

  27. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  28. val tempDir : File

    Temporary directory where compressed version of files can be stored

  29. def toString (): String

    Definition Classes
    StaticFileRequest → AnyRef → Any

  30. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  31. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  32. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any