org.scalatra.fileupload

FileUploadSupport

trait FileUploadSupport extends ServletBase

FileUploadSupport can be mixed into a org.scalatra.ScalatraFilter or org.scalatra.ScalatraServlet to provide easy access to data submitted as part of a multipart HTTP request. Commonly this is used for retrieving uploaded files.

Once the trait has been mixed into your handler you can access any files uploaded using

fileParams("myFile")

where myFile is the name of the parameter used to upload the file being retrieved.

fileParams("myFile") }}} of the parameter used to upload the file being retrieved.

Annotations
@deprecated
Deprecated

(Since version 2.1.0)

Note

Once any handler with FileUploadSupport has accessed the request, the fileParams returned by FileUploadSupport will remain fixed for the lifetime of the request.

Linear Supertypes
ServletBase, ScalatraBase, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FileUploadSupport
  2. ServletBase
  3. ScalatraBase
  4. DefaultImplicitConversions
  5. LowPriorityImplicitConversions
  6. LowestPriorityImplicitConversions
  7. TypeConverterSupport
  8. ScalatraParamsImplicits
  9. Initializable
  10. DynamicScope
  11. RequestResponseScope
  12. CoreDsl
  13. Control
  14. Handler
  15. ScalatraContext
  16. CookieContext
  17. SessionSupport
  18. ServletApiImplicits
  19. AnyRef
  20. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef

    Definition Classes
    Initializable
  2. abstract type ConfigT <: AnyRef { ... /* 3 definitions in type refinement */ }

    Definition Classes
    ServletBase → Initializable
  3. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  4. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. abstract val doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  2. abstract def requestPath(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  3. abstract def routeBasePath(implicit request: HttpServletRequest): String

    Attributes
    protected
    Definition Classes
    ScalatraBase

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. val _fileParams: Map[String, FileItem] { ... /* 2 definitions in type refinement */ }

    Attributes
    protected
  7. def addRoute(method: HttpMethod, transformers: Seq[RouteTransformer], action: ⇒ Any): Route

    Attributes
    protected
    Definition Classes
    ScalatraBase
  8. def addSessionId(uri: String)(implicit response: HttpServletResponse): String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  9. def addStatusRoute(codes: Range, action: ⇒ Any): Unit

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase
  10. def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  11. implicit val anyToBoolean: TypeConverter[Any, Boolean]

    Definition Classes
    LowPriorityImplicitConversions
  12. implicit val anyToByte: TypeConverter[Any, Byte]

    Definition Classes
    LowPriorityImplicitConversions
  13. implicit val anyToDouble: TypeConverter[Any, Double]

    Definition Classes
    LowPriorityImplicitConversions
  14. implicit val anyToFloat: TypeConverter[Any, Float]

    Definition Classes
    LowPriorityImplicitConversions
  15. implicit val anyToInt: TypeConverter[Any, Int]

    Definition Classes
    LowPriorityImplicitConversions
  16. implicit val anyToLong: TypeConverter[Any, Long]

    Definition Classes
    LowPriorityImplicitConversions
  17. implicit val anyToShort: TypeConverter[Any, Short]

    Definition Classes
    LowPriorityImplicitConversions
  18. implicit val anyToString: TypeConverter[Any, String]

    Definition Classes
    LowPriorityImplicitConversions
  19. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  20. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  21. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  22. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. var config: ConfigT

    Definition Classes
    ScalatraBase
  24. implicit def configWrapper(config: ConfigT): Config { object initParameters }

    Attributes
    protected
    Definition Classes
    ServletBase → Initializable
  25. def contentType: String

    Definition Classes
    ScalatraContext
  26. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ScalatraBase
  27. def contentType_=(contentType: String): Unit

    Definition Classes
    ScalatraContext
  28. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  29. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext
  30. def cookies(implicit request: HttpServletRequest): SweetCookies

    Definition Classes
    CookieContext
  31. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  32. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  33. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  34. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  35. implicit def enrichRequest(request: HttpServletRequest): RichRequest

    Definition Classes
    ServletApiImplicits
  36. implicit def enrichResponse(response: HttpServletResponse): RichResponse

    Definition Classes
    ServletApiImplicits
  37. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

    Definition Classes
    ServletApiImplicits
  38. implicit def enrichSession(session: HttpSession): RichSession

    Definition Classes
    ServletApiImplicits
  39. def environment: String

    Definition Classes
    ScalatraBase
  40. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  41. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  42. def error(handler: ErrorHandler): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  43. var errorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ScalatraBase
  44. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  45. def extractStatusCode(e: HaltException): Int

    Attributes
    protected
    Definition Classes
    ScalatraBase
  46. def fileItemFactory: FileItemFactory

    Attributes
    protected
  47. def fileItemToString(req: HttpServletRequest, item: FileItem): String

    Converts a file item to a string.

    Converts a file item to a string.

    Browsers tend to be sloppy about providing content type headers with charset information to form-data parts. Worse, browsers are inconsistent about how they encode these parameters.

    The default implementation attempts to use the charset specified on the request. If that is unspecified, and it usually isn't, then it falls back to the kernel's charset.

    Attributes
    protected
  48. def fileMultiParams: FileMultiParams

    Attributes
    protected
  49. def fileParams: Map[String, FileItem] { ... /* 2 definitions in type refinement */ }

    returns

    a Map, keyed on the names of multipart file upload parameters, of all multipart files submitted with the request

  50. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  51. def format_=(formatValue: String): Unit

    Definition Classes
    ScalatraContext
  52. def format_=(formatValue: Symbol): Unit

    Definition Classes
    ScalatraContext
  53. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase
  54. def get(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  55. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  56. def halt(result: ActionResult): Nothing

    Definition Classes
    Control
  57. def halt[T](status: Integer, body: T, headers: Map[String, String], reason: String)(implicit arg0: Manifest[T]): Nothing

    Definition Classes
    Control
  58. def handle(req: HttpServletRequest, resp: HttpServletResponse): Unit

    Definition Classes
    FileUploadSupport → ServletBase → ScalatraBase → Handler
  59. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  60. def head(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  61. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraBase
  62. def initialize(config: ConfigT): Unit

    Definition Classes
    ScalatraBase → Initializable
  63. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Attributes
    protected
    Definition Classes
    ScalatraBase
  64. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  65. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraBase
  66. def isHttps(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  67. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  68. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]

    Definition Classes
    LowestPriorityImplicitConversions
  69. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  70. def multiParams(implicit request: HttpServletRequest): MultiParams

    Definition Classes
    ScalatraBase
  71. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

    Definition Classes
    ScalatraBase
  72. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  73. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  74. def newServletFileUpload: ServletFileUpload

    Creates a new file upload handler to parse the request.

    Creates a new file upload handler to parse the request. By default, it creates a ServletFileUpload instance with the file item factory returned by the fileItemFactory method. Override this method to customize properties such as the maximum file size, progress listener, etc.

    returns

    a new file upload handler.

    Attributes
    protected
  75. def notFound(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  76. final def notify(): Unit

    Definition Classes
    AnyRef
  77. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  78. def options(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  79. def params(implicit request: HttpServletRequest): Params

    Definition Classes
    ScalatraBase
  80. def params(key: Symbol)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  81. def params(key: String)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  82. def pass(): Nothing

    Definition Classes
    Control
  83. def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  84. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  85. def post(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  86. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  87. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

    Definition Classes
    ScalatraBase
  88. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  89. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase
  90. def removeRoute(method: String, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  91. def removeRoute(method: HttpMethod, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  92. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  93. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    ScalatraBase
  94. def renderResponse(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  95. def renderResponseBody(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  96. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  97. implicit def request: HttpServletRequest

    Definition Classes
    DynamicScope → RequestResponseScope
  98. implicit def response: HttpServletResponse

    Definition Classes
    DynamicScope → RequestResponseScope
  99. lazy val routes: RouteRegistry

    Definition Classes
    ScalatraBase
  100. def runFilters(filters: Traversable[Route]): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  101. def runRoutes(routes: Traversable[Route]): Stream[Any]

    Attributes
    protected
    Definition Classes
    ScalatraBase
  102. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  103. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  104. implicit def scalatraContext: ScalatraContext

    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  105. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

    Definition Classes
    DefaultImplicitConversions
  106. implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  107. def serverHost(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  108. def serverPort(implicit request: HttpServletRequest): Int

    Definition Classes
    ScalatraBase
  109. def servletContext: ServletContext

    Definition Classes
    ScalatraBase → ScalatraContext
  110. def session(key: Symbol)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport
  111. def session(key: String)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport
  112. implicit def session(implicit request: HttpServletRequest): HttpSession

    Definition Classes
    SessionSupport
  113. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

    Definition Classes
    SessionSupport
  114. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  115. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  116. def status: Int

    Definition Classes
    ScalatraContext
  117. def status_=(code: Int): Unit

    Definition Classes
    ScalatraContext
  118. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  119. implicit val stringToBoolean: TypeConverter[String, Boolean]

    Definition Classes
    DefaultImplicitConversions
  120. implicit val stringToByte: TypeConverter[String, Byte]

    Definition Classes
    DefaultImplicitConversions
  121. def stringToDate(format: ⇒ String): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  122. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  123. implicit val stringToDouble: TypeConverter[String, Double]

    Definition Classes
    DefaultImplicitConversions
  124. implicit val stringToFloat: TypeConverter[String, Float]

    Definition Classes
    DefaultImplicitConversions
  125. implicit val stringToInt: TypeConverter[String, Int]

    Definition Classes
    DefaultImplicitConversions
  126. implicit val stringToLong: TypeConverter[String, Long]

    Definition Classes
    DefaultImplicitConversions
  127. implicit val stringToSelf: TypeConverter[String, String]

    Definition Classes
    DefaultImplicitConversions
  128. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  129. implicit val stringToShort: TypeConverter[String, Short]

    Definition Classes
    DefaultImplicitConversions
  130. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  131. def toString(): String

    Definition Classes
    AnyRef → Any
  132. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams

    Definition Classes
    ScalatraParamsImplicits
  133. implicit def toTypedParams(params: Params): TypedParams

    Definition Classes
    ScalatraParamsImplicits
  134. def trap(codes: Range)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  135. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
  136. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase
  137. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  140. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  141. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected[org.scalatra]
    Definition Classes
    DynamicScope → RequestResponseScope
  142. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  143. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S)(implicit request: HttpServletRequest): S

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase

Deprecated Value Members

  1. def _request: DynamicVariable[HttpServletRequest]

    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withRequest to change the binding, or request to get the value

  2. def _response: DynamicVariable[HttpServletResponse]

    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withResponse to change the binding, or response to get the value

  3. def applicationContext: ServletContext

    Definition Classes
    ScalatraBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  4. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use status_=(Int) instead

Inherited from ServletBase

Inherited from ScalatraBase

Inherited from DefaultImplicitConversions

Inherited from LowPriorityImplicitConversions

Inherited from LowestPriorityImplicitConversions

Inherited from TypeConverterSupport

Inherited from ScalatraParamsImplicits

Inherited from Initializable

Inherited from DynamicScope

Inherited from RequestResponseScope

Inherited from CoreDsl

Inherited from Control

Inherited from Handler

Inherited from ScalatraContext

Inherited from CookieContext

Inherited from SessionSupport

Inherited from ServletApiImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped