JacksonSwaggerBase
Attributes
- Graph
-
- Supertypes
-
trait SwaggerBasetrait CorsSupporttrait JacksonJsonSupporttrait JValueResulttrait JacksonJsonOutputtrait JsonMethodstrait JsonSupport[JValue]trait JsonOutput[JValue]trait JsonMethods[JValue]trait ApiFormatstrait ScalatraBasetrait DefaultImplicitConversionstrait LowPriorityImplicitConversionstrait LowestPriorityImplicitConversionstrait TypeConverterSupporttrait ScalatraParamsImplicitstrait Initializabletrait DynamicScopetrait RequestResponseScopetrait CoreDsltrait Controltrait Handlertrait ScalatraContexttrait CookieContexttrait SessionSupporttrait ServletApiImplicitsclass Objecttrait Matchableclass AnyShow all
Members list
Type members
Inherited classlikes
Attributes
- Inherited from:
- Initializable
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- SwaggerBase
- Supertypes
-
class Objecttrait Matchableclass Any
Inherited types
Attributes
- Inherited from:
- Initializable
Value members
Inherited methods
The list of media types accepted by the current request. Parsed from the Accept
header.
The list of media types accepted by the current request. Parsed from the Accept
header.
Attributes
- Inherited from:
- ApiFormats
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.
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.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JsonMethods
Attributes
- Inherited from:
- JsonMethods
Attributes
- Inherited from:
- SwaggerBase
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.
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.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JsonMethods
Gets the content type of the current response.
Gets the content type of the current response.
Attributes
- Inherited from:
- ScalatraContext
Sets the content type of the current response.
Sets the content type of the current response.
Attributes
- Inherited from:
- ScalatraContext
Attributes
- Inherited from:
- CookieContext
A list of formats accepted by default.
A list of formats accepted by default.
Attributes
- Inherited from:
- ApiFormats
The default format.
The default format.
Attributes
- Inherited from:
- ApiFormats
Attributes
- See also
-
get
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- ScalatraBase
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.
Attributes
- Inherited from:
- ScalatraBase
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
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
Attributes
- Inherited from:
- ApiFormats
Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.
Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.
Attributes
- Inherited from:
- ScalatraContext
Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.
Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.
Attributes
- Inherited from:
- ScalatraContext
Attributes
- Inherited from:
- JsonMethods
Attributes
- Inherited from:
- JsonMethods
Builds a full URL from the given relative path. Takes into account the port configuration, https, ...
Builds a full URL from the given relative path. Takes into account the port configuration, https, ...
Value parameters
- path
-
a relative path
Attributes
- Returns
-
the full URL
- Inherited from:
- ScalatraBase
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.
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!" }
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- Control
Immediately halts processing of a request. Can be called from either a before filter or a route.
Immediately halts processing of a request. Can be called from either a before filter or a route.
Value parameters
- body
-
a result to render through the render pipeline as the body
- headers
-
headers to add to the response
- status
-
the status to set on the response, or null to leave the status unchanged.
Attributes
- Inherited from:
- Control
Handles a request and writes to the response.
Handles a request and writes to the response.
Attributes
- Inherited from:
- CorsSupport
Attributes
- See also
-
head
- Inherited from:
- ScalatraBase
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.
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.
Attributes
- Returns
-
true if the format parameter should be included in the returned json
- Inherited from:
- SwaggerBase
The name of the route to use when getting the index listing for swagger defaults to optional resources.:format or /
The name of the route to use when getting the index listing for swagger defaults to optional resources.:format or /
Attributes
- Returns
-
The name of the route
- Inherited from:
- SwaggerBase
Gets an init parameter from the config.
Gets an init parameter from the config.
Value parameters
- name
-
the name of the key
Attributes
- Returns
-
an option containing the value of the parameter if defined, or
None
if the parameter is not set. - Inherited from:
- ScalatraBase
A hook to initialize the class with some configuration after it has been constructed.
A hook to initialize the class with some configuration after it has been constructed.
Not called init because GenericServlet doesn't override it, and then we get into https://lampsvn.epfl.ch/trac/scala/ticket/2497.
Attributes
- Inherited from:
- SwaggerBase
A boolean flag representing whether the kernel is in development mode. The default is true if the environment
begins with "dev", case-insensitive.
A boolean flag representing whether the kernel is in development mode. The default is true if the environment
begins with "dev", case-insensitive.
Attributes
- Inherited from:
- ScalatraBase
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.
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.
By default no parameterNames will be checked
Attributes
- Inherited from:
- JsonOutput
Attributes
- Inherited from:
- JsonMethods
Defines a block to run if matching routes are found only for other methods. The set of matching methods is passed to the block.
Defines a block to run if matching routes are found only for other methods. The set of matching methods is passed to the block.
Attributes
- Inherited from:
- ScalatraBase
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
.
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
.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- ScalatraBase
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.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- See also
-
get
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JsonMethods
Attributes
- Inherited from:
- JsonMethods
Attributes
- Inherited from:
- JsonSupport
Immediately exits from the current route.
Immediately exits from the current route.
Attributes
- Inherited from:
- Control
Attributes
- See also
-
patch
- Inherited from:
- ScalatraBase
Attributes
- See also
-
get
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JsonMethods
Attributes
- See also
-
get
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JacksonJsonSupport
Sends a redirect response and immediately halts the current action.
Sends a redirect response and immediately halts the current action.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JsonMethods
The render pipeline is a partial function of Any => Any. It is called recursively until it returns (). () indicates that the response has been rendered.
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
- Definition Classes
-
JValueResult -> ScalatraBase
- Inherited from:
- JValueResult
Attributes
- Inherited from:
- SwaggerBase
Attributes
- Inherited from:
- ApiFormats
The effective path against which routes are matched. The definition varies between servlets and filters.
The effective path against which routes are matched. The definition varies between servlets and filters.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- JsonSupport
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- ScalatraBase
The servlet context in which this kernel runs.
The servlet context in which this kernel runs.
Attributes
- Inherited from:
- ScalatraBase
Attributes
- Inherited from:
- SessionSupport
The current session. If none exists, None is returned.
The current session. If none exists, None is returned.
Attributes
- Inherited from:
- SessionSupport
A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.
A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.
Attributes
- Inherited from:
- Initializable
Gets the status code of the current response.
Gets the status code of the current response.
Attributes
- Inherited from:
- ScalatraContext
Sets the status code of the current response.
Sets the status code of the current response.
Attributes
- Inherited from:
- ScalatraContext
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Error handler for HTTP response status code range. You can intercept every response code previously specified with #status or even generic 404 error.
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"
}
}*
}}
Attributes
- Inherited from:
- ScalatraBase
Attributes
- See also
-
error
- Inherited from:
- CoreDsl
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.
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.
Value parameters
- params
-
params, to be appended in the form of a query string
- path
-
the base path. If a path begins with '/', then the context path will be prepended to the result
Attributes
- Returns
-
the path plus the query string, if any. The path is run through
response.encodeURL
to add any necessary session tracking parameters. - Inherited from:
- ScalatraBase
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
- Inherited from:
- DynamicScope
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
- Inherited from:
- DynamicScope
Attributes
- Inherited from:
- JacksonJsonOutput
Inherited fields
The configuration, typically a ServletConfig or FilterConfig.
The configuration, typically a ServletConfig or FilterConfig.
Attributes
- Inherited from:
- ScalatraBase
A map of suffixes to content types.
A map of suffixes to content types.
Attributes
- Inherited from:
- ApiFormats
A map of content types to suffixes. Not strictly a reverse of formats
.
A map of content types to suffixes. Not strictly a reverse of formats
.
Attributes
- Inherited from:
- ApiFormats
The routes registered in this kernel.
The routes registered in this kernel.
Attributes
- Inherited from:
- ScalatraBase
Implicits
Inherited implicits
Attributes
- Inherited from:
- SwaggerBase
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- LowPriorityImplicitConversions
Attributes
- Inherited from:
- Initializable
Attributes
- Inherited from:
- CookieContext
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- SwaggerBase
Attributes
- Inherited from:
- ServletApiImplicits
Attributes
- Inherited from:
- ServletApiImplicits
Attributes
- Inherited from:
- ServletApiImplicits
Attributes
- Inherited from:
- ServletApiImplicits
Attributes
- Inherited from:
- SwaggerBase
Attributes
- Inherited from:
- LowestPriorityImplicitConversions
The currently scoped request. Valid only inside the handle
method.
The currently scoped request. Valid only inside the handle
method.
Attributes
- Inherited from:
- DynamicScope
The currently scoped response. Valid only inside the handle
method.
The currently scoped response. Valid only inside the handle
method.
Attributes
- Inherited from:
- DynamicScope
Attributes
- Inherited from:
- TypeConverterSupport
Implicit convert a (String) => Option[T]
function into a TypeConverter[T]
Implicit convert a (String) => Option[T]
function into a TypeConverter[T]
Attributes
- Inherited from:
- TypeConverterSupport
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
The current session. Creates a session if none exists.
The current session. Creates a session if none exists.
Attributes
- Inherited from:
- SessionSupport
Attributes
- Definition Classes
- Inherited from:
- SwaggerBase
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Attributes
- Inherited from:
- DefaultImplicitConversions
Returns the Swagger instance responsible for generating the resource and operation listings.
Returns the Swagger instance responsible for generating the resource and operation listings.
Attributes
- Inherited from:
- SwaggerBase
Attributes
- Inherited from:
- ScalatraParamsImplicits
Attributes
- Inherited from:
- ScalatraParamsImplicits