NativeSwaggerBase

implicit abstract def configWrapper(config: ConfigT): Config

abstract val doNotFound: Action

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

abstract def requestPath(implicit request: HttpServletRequest): String

The effective path against which routes are matched.

abstract def routeBasePath(implicit request: HttpServletRequest): String

The base path for URL generation

implicit abstract def swagger: SwaggerEngine

Returns the Swagger instance responsible for generating the resource and operation listings.

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def acceptHeader(implicit request: HttpServletRequest): List[String]

The list of media types accepted by the current request.

def acceptedFormats(accepted: Symbol*): Boolean

def addMimeMapping(mime: String, extension: String): Unit

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

Prepends a new route for the given HTTP method.

def addSessionId(uri: String)(implicit response: HttpServletResponse): String

def addStatusRoute(codes: Range, action: ⇒ Any): Unit

def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

Adds a filter to run after the route.

implicit val anyToBoolean: TypeConverter[Any, Boolean]

implicit val anyToByte: TypeConverter[Any, Byte]

implicit val anyToDouble: TypeConverter[Any, Double]

implicit val anyToFloat: TypeConverter[Any, Float]

implicit val anyToInt: TypeConverter[Any, Int]

implicit val anyToLong: TypeConverter[Any, Long]

implicit val anyToShort: TypeConverter[Any, Short]

implicit val anyToString: TypeConverter[Any, String]

final def asInstanceOf[T0]: T0

def augmentSimpleRequest(): Unit

def bathPath: Option[String]

def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

Adds a filter to run before the route.

implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

Converts a boolean expression to a route matcher.

def clone(): AnyRef

def compact(d: Document): String

var config: ConfigT

The configuration, typically a ServletConfig or FilterConfig.

def contentType: String

Gets the content type of the current response.

def contentTypeInferrer: ContentTypeInferrer

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

def contentType_=(contentType: String): Unit

Sets the content type of the current response.

def contextPath: String

implicit def cookieOptions: CookieOptions

def cookies(implicit request: HttpServletRequest): SweetCookies

var decodePercentEncodedPath: Boolean

Set whether to decode when the path returned by the requestPath method is Percent-Eoconding.

def defaultAcceptedFormats: List[Symbol]

A list of formats accepted by default.

val defaultCharacterEncoding: String

The default character encoding for requests and responses.

def defaultFormat: Symbol

The default format.

implicit def defaultStringToSeq[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[String, Seq[T]]

def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

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

implicit def docToJson(doc: Api): JValue

implicit def enrichRequest(request: HttpServletRequest): RichRequest

implicit def enrichResponse(response: HttpServletResponse): RichResponse

implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

implicit def enrichSession(session: HttpSession): RichSession

def environment: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(handler: ErrorHandler): Unit

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

var errorHandler: ErrorHandler

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

def executeRoutes(): Unit

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

def extractStatusCode(e: HaltException): Int

def finalize(): Unit

def format(implicit request: HttpServletRequest, response: HttpServletResponse): String

Returns the request-scoped format.

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

def format_=(formatValue: String): Unit

Explicitly sets the request-scoped format.

def format_=(formatValue: Symbol): Unit

Explicitly sets the request-scoped format.

val formats: Map[String, String]

A map of suffixes to content types.

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.

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.

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

post("/echo") {
  "hello {params('name)}!"
}

get("/", request.getRemoteHost == "127.0.0.1") { "Hello localhost!" }

final def getClass(): Class[_]

def halt(result: ActionResult): Nothing

def halt[T](status: Integer = null, body: T = (), headers: Map[String, String] = Map.empty): Nothing

Immediately halts processing of a request.

def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

Handles a request and writes to the response.

def handlePreflightRequest(): Unit

def hashCode(): Int

def head(transformers: RouteTransformer*)(action: ⇒ Any): Route

def includeFormatParameter: Boolean

Whether to include the format parameter in the index listing for swagger defaults to false, the format parameter will not be present but is still optional.

def indexRoute: String

The name of the route to use when getting the index listing for swagger defaults to optional resources.:format or /

def inferFromFormats: ContentTypeInferrer

A content type inferrer based on the format variable.

def initParameter(name: String): Option[String]

Gets an init paramter from the config.

def initialize(config: ConfigT): Unit

A hook to initialize the class with some configuration after it has been constructed.

def invoke(matchedRoute: MatchedRoute): Option[Any]

Invokes a route or filter.

def isAsyncExecutable(result: Any): Boolean

def isDevelopmentMode: Boolean

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

def isHttps(implicit request: HttpServletRequest): Boolean

final def isInstanceOf[T0]: Boolean

implicit def jsonFormats: Formats

def jsonVulnerabilityGuard: Boolean

Whether or not to apply the jsonVulnerabilityGuard when rendering json.

def jsonpCallbackParameterNames: Iterable[String]

If a request is made with a parameter in jsonpCallbackParameterNames it will be assumed that it is a JSONP request and the json will be returned as the argument to a function with the name specified in the corresponding parameter.

implicit def lowestPriorityAny2T[T](implicit arg0: ClassTag[T]): TypeConverter[Any, T]

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

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

val mimeTypes: Map[String, String]

A map of content types to suffixes.

def multiParams(implicit request: HttpServletRequest): MultiParams

The current multiparams.

def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

final def ne(arg0: AnyRef): Boolean

def needsHttps: Boolean

def notFound(fun: ⇒ Any): Unit

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

final def notify(): Unit

final def notifyAll(): Unit

def options(transformers: RouteTransformer*)(action: ⇒ Any): Route

def params(implicit request: HttpServletRequest): Params

def params(key: String)(implicit request: HttpServletRequest): String

def parse(in: JsonInput, useBigDecimalForDouble: Boolean, useBigIntForLong: Boolean): JValue

def parseOpt(in: JsonInput, useBigDecimalForDouble: Boolean, useBigIntForLong: Boolean): Option[JValue]

def parseRequestBody(format: String)(implicit request: HttpServletRequest): JValue

def parsedBody(implicit request: HttpServletRequest): JValue

def pass(): Nothing

Immediately exits from the current route.

def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route

implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

Path pattern is decoupled from requests.

def post(transformers: RouteTransformer*)(action: ⇒ Any): Route

def pretty(d: Document): String

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

def readJsonFromBody(bd: String): JValue

def readXmlFromBody(bd: String): JValue

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

Sends a redirect response and immediately halts the current action.

implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

Converts a regular expression to a route matcher.

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

def removeRoute(method: String, route: Route): Unit

def removeRoute(method: HttpMethod, route: Route): Unit

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

def render(value: JValue)(implicit formats: Formats): Document

def renderHaltException(e: HaltException): Unit

def renderPipeline: RenderPipeline

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

def renderResponse(actionResult: Any): Unit

Renders the action result to the response.

def renderResponseBody(actionResult: Any): Unit

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

def renderSwagger2(docs: List[Api]): JValue

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

implicit def request: HttpServletRequest

The currently scoped request.

def requestFormat(implicit request: HttpServletRequest): String

implicit def response: HttpServletResponse

The currently scoped response.

def rosettaFlashGuard: Boolean

Whether or not to apply the rosetta flash guard when rendering jsonp callbacks.

lazy val routes: RouteRegistry

The routes registered in this kernel.

def runFilters(filters: Iterable[Route]): Unit

Invokes each filters with invoke.

def runRoutes(routes: Iterable[Route]): Stream[Any]

Lazily invokes routes with invoke.

implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]

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

implicit def scalatraContext: ScalatraContext

def secureXML: XMLLoader[Elem]

implicit def seqHead[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[Seq[String], T]

implicit def seqToSeq[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[Seq[String], Seq[T]]

def serverHost(implicit request: HttpServletRequest): String

def serverPort(implicit request: HttpServletRequest): Int

def servletContext: ServletContext

The servlet context in which this kernel runs.

def session(key: String)(implicit request: HttpServletRequest): Any

implicit def session(implicit request: HttpServletRequest): HttpSession

The current session.

def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

The current session.

def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit

def shutdown(): Unit

A hook to shutdown the class.

def status: Int

Gets the status code of the current response.

def status_=(code: Int): Unit

Sets the status code of the current response.

implicit def string2RouteMatcher(path: String): RailsRouteMatcher

implicit val stringToBoolean: TypeConverter[String, Boolean]

implicit val stringToByte: TypeConverter[String, Byte]

def stringToDate(format: ⇒ String): TypeConverter[String, Date]

def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]

implicit val stringToDouble: TypeConverter[String, Double]

implicit val stringToFloat: TypeConverter[String, Float]

implicit val stringToInt: TypeConverter[String, Int]

implicit val stringToLong: TypeConverter[String, Long]

implicit val stringToSelf: TypeConverter[String, String]

def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String = ",")(implicit arg0: ClassTag[T]): TypeConverter[String, Seq[T]]

implicit val stringToShort: TypeConverter[String, Short]

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

def toString(): String

implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams

implicit def toTypedParams(params: Params): TypedParams

def transformRequestBody(body: JValue): JValue

def transformResponseBody(body: JValue): JValue

def trap(codes: Range)(block: ⇒ Any): Unit

Error handler for HTTP response status code range.

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

def trap(code: Int)(block: ⇒ Any): Unit

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.

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

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

def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

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

def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S)(implicit request: HttpServletRequest): S

def writeJson(json: JValue, writer: Writer): Unit

def writeJsonAsXml(json: JValue, writer: Writer): Unit

lazy val xmlRootNode: Elem