SkinnyResource

abstract def createForm: MapValidator

Input form for creation

abstract def createFormStrongParameters: Seq[(String, ParamType)]

Strong parameter definitions for creation form

abstract def model: SkinnyModel[Long, _]

SkinnyModel for this resource.

abstract def resourceName: String

Resource name in the singular.

abstract def resourcesName: String

Resource name in the plural.

abstract def updateForm: MapValidator

Input form for modification

abstract def updateFormStrongParameters: Seq[(String, ParamType)]

Strong parameter definitions for modification form

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

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

def acceptedFormats(accepted: Symbol*): Boolean

val actionDefinitions: ArrayBuffer[ActionDefinition]

Note: Same action method name should be registered several times.

def addActionDefinition(actionDef: ActionDefinition): Unit

Adds action definition

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

def addParam(name: String, value: Any)(implicit req: HttpServletRequest = request): Unit

Add param to params in the request scope.

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

Override to append HTTP method information to Route objects.

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

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

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

def afterAction(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

Registers afterAction to this controller.

def afterFilter(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

If you prefer #afterFilter than #afterAction, keep going!

implicit val anyToBoolean: org.scalatra.util.conversion.TypeConverter[Any, Boolean]

implicit val anyToByte: org.scalatra.util.conversion.TypeConverter[Any, Byte]

implicit val anyToDouble: org.scalatra.util.conversion.TypeConverter[Any, Double]

implicit val anyToFloat: org.scalatra.util.conversion.TypeConverter[Any, Float]

implicit val anyToInt: org.scalatra.util.conversion.TypeConverter[Any, Int]

implicit val anyToLong: org.scalatra.util.conversion.TypeConverter[Any, Long]

implicit val anyToShort: org.scalatra.util.conversion.TypeConverter[Any, Short]

implicit val anyToString: org.scalatra.util.conversion.TypeConverter[Any, String]

final def asInstanceOf[T0]: T0

def asJValue[T](obj: T)(implicit writer: Writer[T]): JValue

def awaitFutures[A](duration: Duration)(fs: Future[A]*)(implicit ec: ExecutionContext): Seq[A]

Awaits multiple Future's results.

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

def beforeAction(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

Registers beforeAction to this controller.

def beforeFilter(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

If you prefer #beforeFilter than #beforeAction, keep going!

implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

def cacheRequestBodyAsString: Boolean

lazy val charset: Option[String]

Default charset.

def clone(): AnyRef

def compact(value: JValue): String

Returns JSON string value.

var config: ConfigT

implicit def configWrapper(config: ConfigT): Config { object initParameters }

def contentType: String

def contentTypeInferrer: ContentTypeInferrer

def contentType_=(contentType: String): Unit

def contextPath: String

implicit def convertParamsToStrongParameters(params: org.scalatra.Params): StrongParameters

implicit def convertRouteToRichRoute(route: Route)(implicit controller: SkinnyControllerBase): RichRoute

implicit def cookieOptions: CookieOptions

def cookies: SweetCookies

def countResources(): Long

def createApiAction: Any

val createApiUrl: Route

def createI18n()(implicit locale: Locale = currentLocale.orNull[Locale]): I18n

Creates skinny.I18n instance for current locale.

def createParams: Params

Params for creation.

def createRenderContext(req: HttpServletRequest = request, resp: HttpServletResponse = response, out: PrintWriter = response.getWriter): RenderContext

Creates a RenderContext instance for Skinny app.

def createResource()(implicit format: Format = Format.HTML): Any

Creates new resource.

def createTemplateEngine(config: ConfigT): TemplateEngine

Creates TemplateEngine instance for Skinny app.

val createUrl: Route

val createWithSlashUrl: Route

def csrfKey: String

Overrides Scalatra's default key name.

def csrfToken(implicit request: HttpServletRequest): String

def currentActionName: Option[Symbol]

Returns action name for this request.

def currentLocale(implicit req: HttpServletRequest = request): Option[Locale]

Returns current locale for this request.

def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

def debug(msg: ⇒ Any): Unit

def debugLoggingParameters(form: MapValidator, id: Option[Long] = None): Unit

Outputs debug logging for passed parameters.

def debugLoggingPermittedParameters(parameters: PermittedStrongParameters, id: Option[Long] = None): Unit

Outputs debug logging for permitted parameters.

def defaultAcceptedFormats: List[Symbol]

val defaultCharacterEncoding: String

def defaultFormat: Symbol

def defaultIndexName: String

def defaultLayoutPath: Option[String]

def defaultLocale: Option[Locale]

Returns default locale.

implicit def defaultStringToSeq[T](implicit elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], mf: Manifest[T]): org.scalatra.util.conversion.TypeConverter[String, Seq[T]]

def defaultTemplateFormat: String

def defaultTemplatePath: List[String]

Overrides to make the template path simpler.

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

def deleteAction: Any

def deleteApiAction: Any

def destroy(): Unit

val destroyApiUrl: Route

def destroyResource(id: Long)(implicit format: Format = Format.HTML): Any

Destroys the specified resource.

val destroyUrl: Route

def doCreateAndReturnId(parameters: PermittedStrongParameters): Long

Executes resource creation.

def doDestroy(id: Long): Int

Executes deletion of the specified single resource.

def doFilter(request: ServletRequest, response: ServletResponse, chain: FilterChain): Unit

var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

var doNotFound: Action

def doUpdate(id: Long, parameters: PermittedStrongParameters): Int

Executes modification for the specified resource.

def editResource(id: Long)(implicit format: Format = Format.HTML): Any

Shows input form for modification.

val editUrl: Route

def enablePagination: Boolean

implicit def enrichRequest(request: HttpServletRequest): RichRequest

implicit def enrichResponse(response: HttpServletResponse): RichResponse

implicit def enrichServletContext(servletContext: javax.servlet.ServletContext): RichServletContext

implicit def enrichSession(session: HttpSession): RichSession

def environment: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

def error(msg: ⇒ Any): Unit

def error(handler: ErrorHandler): Unit

var errorHandler: ErrorHandler

def errorMessages(implicit req: HttpServletRequest = request): Seq[String]

Returns errorMessages in the RequestScope.

def executeRoutes(): Unit

def extractStatusCode(e: HaltException): Int

def filterChain: FilterChain

def finalize(): Unit

def findResource(id: Long): Option[_]

def findResources(): List[_]

def findResources(pageSize: Int, pageNo: Int): List[_]

def findTemplate(path: String, extensionSet: Set[String]): Option[String]

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

def flash(implicit request: HttpServletRequest): FlashMap

def flashMapSetSession(f: FlashMap): Unit

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

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

def format_=(formatValue: String): Unit

def format_=(formatValue: Symbol): Unit

val formats: Map[String, String]

def fromJSONString[A](json: String, underscoreKeys: Boolean = false, asIs: Boolean = false)(implicit mf: Manifest[A]): Option[A]

Extracts a value from JSON string.

def fromJSONStringAsIs[A](json: String)(implicit mf: Manifest[A]): Option[A]

Extracts a value from JSON string.

case class Something(fooBar_baz: String)
val something = new Something("foo")
val json = toJSONString(something)
val something2 = fromJSONStringAsIs[Something](json)
something2.map(_.fooBar_baz) should equal(Some(something.fooBar_Baz))

def fromJSONStringToJValue(json: String, underscoreKeys: Boolean = false, asIs: Boolean = false): Option[JValue]

Extracts a JSON value from JSON string.

def fromJValue[T](json: JValue)(implicit reader: Reader[T]): T

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

def futureWithRequest[A](op: (HttpServletRequest) ⇒ A)(implicit ec: ExecutionContext, req: HttpServletRequest): Future[A]

Creates a future with implicit request.

def generateWelcomePageIfAbsent(path: String)(implicit format: Format = Format.HTML): Unit

Generates a sample page for absent page.

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

final def getClass(): Class[_]

def getFromRequestScope[A](key: String)(implicit req: HttpServletRequest = request): Option[A]

Fetches value from request scope.

def halt(result: ActionResult): Nothing

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

def haltWithBody[A](httpStatus: Int)(implicit format: Format = Format.HTML): A

Halts with body which responds to the specified format.

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

def handleForgery(): Unit

Overrides to skip execution when the current request matches excluded patterns.

def handleForgeryIfDetected(): Nothing

Handles when CSRF is detected.

def hashCode(): Int

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

def idName: String

Id field name.

def idParamName: String

Id parameter name.

def indexApiAction: Any

val indexApiUrl: Route

val indexUrl: Route

val indexWithSlashUrl: Route

def inferFromFormats: ContentTypeInferrer

def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

def info(msg: ⇒ Any): Unit

def init(filterConfig: FilterConfig): Unit

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

def initialize(config: ConfigT): Unit

def initializeRequestScopeAttributes(implicit req: HttpServletRequest): Any

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

def isAsyncExecutable(result: Any): Boolean

def isDebugEnabled: Boolean

def isDevelopment(): Boolean

Predicates current env is "development" or "dev".

def isDevelopmentMode: Boolean

def isErrorEnabled: Boolean

def isForged: Boolean

def isHttps(implicit request: HttpServletRequest): Boolean

def isInfoEnabled: Boolean

final def isInstanceOf[T0]: Boolean

def isProduction(): Boolean

Predicates current env is "production" or "prod".

def isScalateErrorPageEnabled: Boolean

To deal with exceptions.

def isStaging(): Boolean

Predicates current env is "staging" or "qa".

def isTest(): Boolean

Predicates current env is "test".

def isTraceEnabled: Boolean

def isWarnEnabled: Boolean

def itemName: String

Item variable name in view templates.

def itemsName: String

Items variable name in view templates.

def jade(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

implicit val jsonFormats: Formats

JSON format support implicitly.

lazy val jsonVulnerabilityGuard: Boolean

def jsonpCallbackParameterNames: Iterable[String]

def keyAndErrorMessages(implicit req: HttpServletRequest = request): Map[String, Seq[String]]

Returns keyAndErrorMessages in the RequestScope.

def layout(path: String)(implicit request: HttpServletRequest): ScalateTemplateEngineFeature

Replaces layout template for this action.

def layoutTemplate(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

def layoutTemplateAs(ext: Set[String])(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

def logger: Logger

def loggerName: String

implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): org.scalatra.util.conversion.TypeConverter[Any, T]

def mapper: ObjectMapper

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

val mimeTypes: Map[String, String]

def mount(ctx: ServletContext): Unit

def multiParams(implicit request: HttpServletRequest): org.scalatra.MultiParams

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

def mustache(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

final def ne(arg0: AnyRef): Boolean

def needsHttps: Boolean

def newResource()(implicit format: Format = Format.HTML): Any

Shows input form for creation.

val newUrl: Route

final def normalizedResourcesBasePath: String

Normalized base path.

def notFound(fun: ⇒ Any): Unit

final def notify(): Unit

final def notifyAll(): Unit

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

def pageNoParamName: String

def pageSize: Int

def params(implicit request: HttpServletRequest): org.scalatra.Params

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

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

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

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

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

def parsedBody(implicit request: HttpServletRequest): JValue

def pass(): Nothing

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

implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

def preferredScalateExtension: String

The Scalate template type that is searched for first.

def prefixForJSONVulnerabilityProtection: String

the prefix for JSON Vulnerability Protection.

def prepareCsrfToken(): Any

def pretty(d: JValue): String

def protectFromForgery(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil): Unit

Declarative activation of CSRF protection.

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

def readJsonFromBody(bd: String): JValue

def readJsonFromStream(stream: InputStream): JValue

def readJsonFromStreamWithCharset(stream: InputStream, charset: String): JValue

def readXmlFromBody(bd: String): JValue

def readXmlFromStream(stream: InputStream): JValue

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

def redirect301(location: String, headers: Map[String, String] = Map.empty, reason: String = ""): ActionResult

Responds as "301 Moved Permanently"

def redirect302(location: String, headers: Map[String, String] = Map.empty, reason: String = ""): ActionResult

Responds as "302 Found"

def redirect303(location: String, headers: Map[String, String] = Map.empty, reason: String = ""): ActionResult

Responds as "303 See Other"

implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

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

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

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

def render(path: String)(implicit format: Format = Format.HTML): String

Renders body with template.

def render(value: JValue): JValue

def renderHaltException(e: HaltException): Unit

def renderPipeline: RenderPipeline

def renderResponse(actionResult: Any): Unit

def renderResponseBody(actionResult: Any): Unit

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

def renderWithFormat(entity: Any)(implicit format: Format = Format.HTML): String

Renders body which responds to the specified format (JSON, XML) if possible.

def renderWithTemplate(path: String)(implicit format: Format = Format.HTML): String

Renders body with template.

implicit def request: HttpServletRequest

def requestFormat(implicit request: HttpServletRequest): String

def requestPath(implicit request: HttpServletRequest): String

def requestScope(keyAndValues: Seq[(String, Any)])(implicit req: HttpServletRequest): RequestScopeFeature

Set attributes to request scope.

def requestScope(keyAndValue: (String, Any))(implicit req: HttpServletRequest): RequestScopeFeature

Set attribute to request scope.

def requestScope(implicit req: HttpServletRequest = request): Map[String, Any]

Returns whole request scope attributes.

def resourcesBasePath: String

Base path.

def resourcesBasePathPrefix: String

Base path prefix.

def respondTo: Seq[Format]

Defines formats to be respond.

implicit def response: HttpServletResponse

def responseAsJSON(entity: Any, charset: Option[String] = Some("utf-8"), prettify: Boolean = false, underscoreKeys: Boolean = useUnderscoreKeysForJSON)(implicit scalatraContext: ScalatraContext): String

Returns JSON response.

def routeBasePath(implicit request: HttpServletRequest): String

def routeForShowApi: Route

lazy val routes: RouteRegistry

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

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

implicit def safe[S, T](f: (S) ⇒ T): org.scalatra.util.conversion.TypeConverter[S, T]

implicit def safeOption[S, T](f: (S) ⇒ Option[T]): org.scalatra.util.conversion.TypeConverter[S, T]

def scalateExtensions: List[String]

Scalate extension names.

def scalateRenderContextNumberFormat: DecimalFormat

Creates a DecimalFormat instance to be use by default.

implicit def scalatraContext: ScalatraContext

implicit val scalatraParamsIdTypeConverter: org.scalatra.util.conversion.TypeConverter[String, Long]

to enable params.getAs[Id]("id")

def scaml(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

def sensitiveParameterNames: Seq[String]

Returns registered sensitive parameter names.

implicit def seqHead[T](implicit elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], mf: Manifest[T]): org.scalatra.util.conversion.TypeConverter[Seq[String], T]

implicit def seqToSeq[T](implicit elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], mf: Manifest[T]): org.scalatra.util.conversion.TypeConverter[Seq[String], Seq[T]]

def serverHost(implicit request: HttpServletRequest): String

def serverPort(implicit request: HttpServletRequest): Int

def servletContext: javax.servlet.ServletContext

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

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

implicit def session(implicit request: HttpServletRequest): HttpSession

def sessionLocaleKey: String

Session key to store current locale string.

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

def set(keyAndValues: Seq[(String, Any)])(implicit req: HttpServletRequest): RequestScopeFeature

Set attributes to request scope.

def set(keyAndValue: (String, Any))(implicit req: HttpServletRequest): RequestScopeFeature

Set attribute to request scope.

def setAsParams(model: Any)(implicit req: HttpServletRequest = request): Unit

Set params which is generated from a model object using Java reflection APIs.

def setContentTypeFromSkinnyApiResourceExtParam: Unit

Set Content-Type response header which is suitable for specified extension.

def setContentTypeIfAbsent()(implicit format: Format = Format.HTML): Unit

Set Content-Type for the format if absent.

def setCreateCompletionFlash(): Unit

Set notice flash message for successful completion of creation.

def setCurrentLocale(locale: String)(implicit req: HttpServletRequest = request): Unit

Set current locale.

def setDestroyCompletionFlash(): FlashMap

Set notice flash message for successful completion of deletion.

def setI18n(implicit req: HttpServletRequest = request, locale: Locale = ...): RequestScopeFeature

Set {{skinny.I18n}} object for the current request to request scope.

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

def setParams(implicit req: HttpServletRequest = request): Unit

Set params to request scope.

def setParamsToRequestScope(implicit req: HttpServletRequest = request): Unit

Set params to request scope.

def setUpdateCompletionFlash(): FlashMap

Set notice flash message for successful completion of modification.

def shouldParseBody(fmt: String)(implicit request: HttpServletRequest): Boolean

def showApiAction: Any

val showApiUrl: Route

val showExtUrl: Route

def showResource(id: Long)(implicit format: Format = Format.HTML): Any

Show single resource.

def showResources()(implicit format: Format = Format.HTML): Any

Shows a list of resource.

val showUrl: Route

def shutdown(): Unit

implicit val skinnyController: skinny.SkinnyControllerBase

Pass this controller instance implicitly because skinny.routing.implicits.RoutesAsImplicits expects skinny.controller.SkinnyControllerBase.

def skinnyEnv: Option[String]

Env string value from "skinny.env" or "org.scalatra.environment".

implicit def skinnyValidatorSafe[S, T](f: (S) ⇒ T): ParamValueTypeConverter[S, T]