org.scalatra

ApiFormats

trait ApiFormats extends ScalatraBase

Adds support for mapping and inferring formats to content types.

$ - Provides a request-scoped format variable $ - Maps formats to content types and vice versa $ - Augments the content-type inferrer to use the format

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ApiFormats
  2. ScalatraBase
  3. CookieSupport
  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

    Definition Classes
    Initializable
  3. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  4. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. implicit abstract def configWrapper(config: ConfigT): Config

    Attributes
    protected
    Definition Classes
    Initializable
  2. abstract val doNotFound: Action

    Called if no route matches the current request for any method.

    Called if no route matches the current request for any method. The default implementation varies between servlet and filter.

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

    The effective path against which routes are matched.

    The effective path against which routes are matched. The definition varies between servlets and filters.

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

    The base path for URL generation

    The base path for URL generation

    Attributes
    protected
    Definition Classes
    ScalatraBase

Concrete Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. def acceptHeader(implicit request: HttpServletRequest): List[String]

    The list of media types accepted by the current request.

    The list of media types accepted by the current request. Parsed from the Accept header.

  5. def acceptedFormats(accepted: Symbol*): Boolean

    Attributes
    protected
  6. def addMimeMapping(mime: String, extension: String): Unit

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

    Prepends a new route for the given HTTP method.

    Prepends a new route for the given HTTP method.

    Can be overriden so that subtraits can use their own logic. Possible examples: $ - restricting protocols $ - namespace routes based on class name $ - raising errors on overlapping entries.

    This is the method invoked by get(), post() etc.

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.ScalatraKernel#removeRoute

  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

    Adds a filter to run after the route.

    Adds a filter to run after the route. The filter only runs if each routeMatcher returns Some. If the routeMatchers list is empty, the filter runs for all routes.

    Definition Classes
    ScalatraBaseCoreDsl
  11. implicit val anyToBoolean: TypeConverter[Any, Boolean]

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

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

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

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

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

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

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

  19. final def asInstanceOf[T0]: T0

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

    Adds a filter to run before the route.

    Adds a filter to run before the route. The filter only runs if each routeMatcher returns Some. If the routeMatchers list is empty, the filter runs for all routes.

    Definition Classes
    ScalatraBaseCoreDsl
  21. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Converts a boolean expression to a route matcher.

    Converts a boolean expression to a route matcher.

    block

    a block that evaluates to a boolean

    returns

    a route matcher based on block. The route matcher should return Some if the block is true and None if the block is false.

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.BooleanBlockRouteMatcher

  22. def clone(): AnyRef

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

    The configuration, typically a ServletConfig or FilterConfig.

    The configuration, typically a ServletConfig or FilterConfig.

    Definition Classes
    ScalatraBase
  24. def contentType: String

    Gets the content type of the current response.

    Gets the content type of the current response.

    Definition Classes
    ScalatraContext
  25. def contentTypeInferrer: ContentTypeInferrer

    A partial function to infer the content type from the action result.

    A partial function to infer the content type from the action result.

    returns

    $ - "text/plain" for String $ - "application/octet-stream" for a byte array $ - "text/html" for any other result

    Attributes
    protected
    Definition Classes
    ApiFormatsScalatraBase
  26. def contentType_=(contentType: String): Unit

    Sets the content type of the current response.

    Sets the content type of the current response.

    Definition Classes
    ScalatraContext
  27. def contextPath: String

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

    Definition Classes
    CookieContext
  29. def cookies: SweetCookies

    Definition Classes
    CookieContext
  30. def defaultAcceptedFormats: List[Symbol]

    A list of formats accepted by default.

  31. val defaultCharacterEncoding: String

    The default character encoding for requests and responses.

    The default character encoding for requests and responses.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  32. def defaultFormat: Symbol

    The default format.

  33. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  35. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Called if no route matches the current request method, but routes match for other methods.

    Called if no route matches the current request method, but routes match for other methods. By default, sends an HTTP status of 405 and an Allow header containing a comma-delimited list of the allowed methods.

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

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

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

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

    Definition Classes
    ServletApiImplicits
  40. def environment: String

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

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

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

    Defines an error handler for exceptions thrown in either the before block or a route action.

    Defines an error handler for exceptions thrown in either the before block or a route action.

    If the error handler does not match, the result falls through to the previously defined error handler. The default error handler simply rethrows the exception.

    The error handler is run before the after filters, and the result is rendered like a standard response. It is the error handler's responsibility to set any appropriate status code.

    Definition Classes
    ScalatraBaseCoreDsl
  44. var errorHandler: ErrorHandler

    The error handler function, called if an exception is thrown during before filters or the routes.

    The error handler function, called if an exception is thrown during before filters or the routes.

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

    Executes routes in the context of the current request and response.

    Executes routes in the context of the current request and response.

    $ 1. Executes each before filter with runFilters. $ 2. Executes the routes in the route registry with runRoutes for the request's method. a. The result of runRoutes becomes the _action result_. b. If no route matches the requested method, but matches are found for other methods, then the doMethodNotAllowed hook is run with each matching method. c. If no route matches any method, then the doNotFound hook is run, and its return value becomes the action result. $ 3. If an exception is thrown during the before filters or the route $ actions, then it is passed to the errorHandler function, and its $ result becomes the action result. $ 4. Executes the after filters with runFilters. $ 5. The action result is passed to renderResponse.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  47. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  48. def format(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Returns the request-scoped format.

    Returns the request-scoped format. If not explicitly set, the format is: $ - the format request parameter, if present in formatParams $ - the first match from Accept header, looked up in mimeTypes $ - the format from the Content-Type header, as looked up in mimeTypes $ - the default format

  49. def formatForMimeTypes(mimeTypes: String*): Option[String]

    Attributes
    protected
  50. def format_=(formatValue: String): Unit

    Explicitly sets the request-scoped format.

    Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.

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

    Explicitly sets the request-scoped format.

    Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.

    Definition Classes
    ScalatraContext
  52. val formats: Map[String, String]

    A map of suffixes to content types.

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

    Builds a full URL from the given relative path.

    Builds a full URL from the given relative path. Takes into account the port configuration, https, ...

    path

    a relative path

    returns

    the full URL

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

    The Scalatra DSL core methods take a list of org.scalatra.RouteMatcher and a block as the action body.

    The Scalatra DSL core methods take a list of org.scalatra.RouteMatcher and a block as the action body. The return value of the block is rendered through the pipeline and sent to the client as the response body.

    See org.scalatra.ScalatraBase#renderResponseBody for the detailed behaviour and how to handle your response body more explicitly, and see how different return types are handled.

    The block is executed in the context of a CoreDsl instance, so all the methods defined in this trait are also available inside the block.

    get("/") {
      <form action="/echo">
        <label>Enter your name</label>
        <input type="text" name="name"/>
      </form>
    }
    
    post("/echo") {
      "hello {params('name)}!"
    }

    ScalatraKernel provides implicit transformation from boolean blocks, strings and regular expressions to org.scalatra.RouteMatcher, so you can write code naturally.

    get("/", request.getRemoteHost == "127.0.0.1") { "Hello localhost!" }
    Definition Classes
    ScalatraBaseCoreDsl
  55. final def getClass(): Class[_]

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

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

    Immediately halts processing of a request.

    Immediately halts processing of a request. Can be called from either a before filter or a route.

    status

    the status to set on the response, or null to leave the status unchanged.

    body

    a result to render through the render pipeline as the body

    headers

    headers to add to the response

    reason

    the HTTP status reason to set, or null to leave unchanged.

    Definition Classes
    Control
  58. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Handles a request and renders a response.

    Handles a request and renders a response.

    $ 1. If the request lacks a character encoding, defaultCharacterEncoding is set to the request.

    $ 2. Sets the response's character encoding to defaultCharacterEncoding.

    $ 3. Binds the current request, response, and multiParams, and calls executeRoutes().

    Definition Classes
    ScalatraBaseHandler
  59. def hashCode(): Int

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    head

  61. def inferFromFormats: ContentTypeInferrer

    A content type inferrer based on the format variable.

    A content type inferrer based on the format variable. Looks up the media type from the formats map. If not found, returns application/octet-stream. This inferrer is prepended to the inherited one.

    Attributes
    protected
  62. def initParameter(name: String): Option[String]

    Gets an init paramter from the config.

    Gets an init paramter from the config.

    name

    the name of the key

    returns

    an option containing the value of the parameter if defined, or None if the parameter is not set.

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

    Initializes the kernel.

    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.

    config

    the configuration.

    Definition Classes
    ScalatraBaseInitializable
  64. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Invokes a route or filter.

    Invokes a route or filter. The multiParams gathered from the route matchers are merged into the existing route params, and then the action is run.

    matchedRoute

    the matched route to execute

    returns

    the result of the matched route's action wrapped in Some, or None if the action calls pass.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  66. def isDevelopmentMode: Boolean

    A boolean flag representing whether the kernel is in development mode.

    A boolean flag representing whether the kernel is in development mode. The default is true if the environment begins with "dev", case-insensitive.

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

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

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

  70. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Defines a block to run if matching routes are found only for other methods.

    Defines a block to run if matching routes are found only for other methods. The set of matching methods is passed to the block.

    Definition Classes
    ScalatraBaseCoreDsl
  71. val mimeTypes: Map[String, String]

    A map of content types to suffixes.

    A map of content types to suffixes. Not strictly a reverse of formats.

  72. def multiParams(implicit request: HttpServletRequest): MultiParams

    The current multiparams.

    The current multiparams. Multiparams are a result of merging the standard request params (query string or post params) with the route parameters extracted from the route matchers of the current route. The default value for an unknown param is the empty sequence. Invalid outside handle.

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

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

    Definition Classes
    AnyRef
  75. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  76. def notFound(fun: ⇒ Any): Unit

    Defines a block to run if no matching routes are found, or if all matching routes pass.

    Defines a block to run if no matching routes are found, or if all matching routes pass.

    Definition Classes
    ScalatraBaseCoreDsl
  77. final def notify(): Unit

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

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  80. def params(implicit request: HttpServletRequest): Params

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

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

    Definition Classes
    ScalatraBase
  83. def pass(): Nothing

    Immediately exits from the current route.

    Immediately exits from the current route.

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    patch

  85. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Path pattern is decoupled from requests.

    Path pattern is decoupled from requests. This adapts the PathPattern to a RouteMatcher by supplying the request path.

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  87. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  88. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

    Sends a redirect response and immediately halts the current action.

    Sends a redirect response and immediately halts the current action.

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

    Converts a regular expression to a route matcher.

    Converts a regular expression to a route matcher.

    regex

    the regular expression

    returns

    a route matcher based on regex

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.RegexRouteMatcher

  90. def relativeUrl(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true)(implicit request: HttpServletRequest, response: HttpServletResponse): String

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

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

    Removes _all_ the actions of a given route for a given HTTP method.

    Removes _all_ the actions of a given route for a given HTTP method. If addRoute is overridden then this should probably be overriden too.

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.ScalatraKernel#addRoute

  93. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  94. def renderPipeline: RenderPipeline

    The render pipeline is a partial function of Any => Any.

    The render pipeline is a partial function of Any => Any. It is called recursively until it returns (). () indicates that the response has been rendered.

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

    Renders the action result to the response.

    Renders the action result to the response. $ - If the content type is still null, call the contentTypeInferrer. $ - Call the render pipeline on the result.

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

    Renders the action result to the response body via the render pipeline.

    Renders the action result to the response body via the render pipeline.

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    #renderPipeline

  97. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

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

    The currently scoped request.

    The currently scoped request. Valid only inside the handle method.

    Definition Classes
    DynamicScopeRequestResponseScope
  99. def requestFormat(implicit request: HttpServletRequest): String

  100. implicit def response: HttpServletResponse

    The currently scoped response.

    The currently scoped response. Valid only inside the handle method.

    Definition Classes
    DynamicScopeRequestResponseScope
  101. lazy val routes: RouteRegistry

    The routes registered in this kernel.

    The routes registered in this kernel.

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

    Invokes each filters with invoke.

    Invokes each filters with invoke. The results of the filters are discarded.

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

    Lazily invokes routes with invoke.

    Lazily invokes routes with invoke. The results of the routes are returned as a stream.

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

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

    Implicit convert a (String) => Option[T] function into a TypeConverter[T]

    Implicit convert a (String) => Option[T] function into a TypeConverter[T]

    Definition Classes
    TypeConverterSupport
  106. implicit def scalatraContext: ScalatraContext

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

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

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

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

    Definition Classes
    ScalatraBase
  111. def servletContext: ServletContext

    The servlet context in which this kernel runs.

    The servlet context in which this kernel runs.

    Definition Classes
    ScalatraBaseScalatraContext
  112. def session(key: Symbol)(implicit request: HttpServletRequest): Any

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

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

    The current session.

    The current session. Creates a session if none exists.

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

    The current session.

    The current session. If none exists, None is returned.

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

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

    A hook to shutdown the class.

    A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.

    Attributes
    protected
    Definition Classes
    Initializable
  118. def status: Int

    Gets the status code of the current response.

    Gets the status code of the current response.

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

    Sets the status code of the current response.

    Sets the status code of the current response.

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

    Pluggable way to convert a path expression to a route matcher.

    Pluggable way to convert a path expression to a route matcher. The default implementation is compatible with Sinatra's route syntax.

    path

    a path expression

    returns

    a route matcher based on path

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  133. def toString(): String

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

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

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

    Error handler for HTTP response status code range.

    Error handler for HTTP response status code range. You can intercept every response code previously specified with #status or even generic 404 error.

    trap(403) {
     "You are not authorized"
    }
     }*

    }}

    Definition Classes
    ScalatraBaseCoreDsl
  137. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    See also

    error

  138. def url(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, absolutize: Boolean = true, withSessionId: Boolean = true)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Returns a context-relative, session-aware URL for a path and specified parameters.

    Returns a context-relative, session-aware URL for a path and specified parameters. Finally, the result is run through response.encodeURL for a session ID, if necessary.

    path

    the base path. If a path begins with '/', then the context path will be prepended to the result

    params

    params, to be appended in the form of a query string

    returns

    the path plus the query string, if any. The path is run through response.encodeURL to add any necessary session tracking parameters.

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

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

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

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

    Executes the block with the given request bound to the request method.

    Executes the block with the given request bound to the request method.

    Attributes
    protected
    Definition Classes
    DynamicScopeRequestResponseScope
  143. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScopeRequestResponseScope
  144. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Executes the block with the given response bound to the response method.

    Executes the block with the given response bound to the response method.

    Attributes
    protected
    Definition Classes
    DynamicScopeRequestResponseScope
  145. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ApiFormatsScalatraBase

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 responseFormat(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) format now means the same as responseFormat, responseFormat will be removed eventually

  5. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

Inherited from ScalatraBase

Inherited from CookieSupport

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