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[_]

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 mofidication form

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

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): Unit

Add param to params in the request scope.

def addRoute(method: HttpMethod, transformers: Seq[(Route) ⇒ Route], 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: (Route) ⇒ Route*)(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: 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 asJValue[T](obj: T)(implicit writer: Writer[T]): JValue

def basePath: String

Base path.

def basePathPrefix: String

Base path prefix.

def before(transformers: (Route) ⇒ Route*)(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(d: JValue): String

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 createI18n()(implicit locale: Locale = currentLocale.orNull[Locale]): I18n

Creates skinny.

def createParams: Params

Params for creation.

def createRenderContext(req: HttpServletRequest, resp: HttpServletResponse, out: PrintWriter): RenderContext

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

Creates new resource.

def createTemplateEngine(config: ConfigT): TemplateEngine

Creates TemplateEngine instance for Skinny app.

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: 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]

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

def defaultTemplateFormat: String

def defaultTemplatePath: List[String]

Overrides to make the template path simpler.

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

def destroy(): Unit

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

Destroys the specified resource.

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: () ⇒ Any

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.

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 executeRoutes(): Unit

def filterChain: FilterChain

def finalize(): Unit

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): String

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

def format_=(formatValue: String): Unit

def format_=(formatValue: Symbol): Unit

val formats: Map[String, String]

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

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

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

Generates a sample page for absent page.

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

final def getClass(): Class[_]

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(): Unit

Handles when CSRF is detected.

def hashCode(): Int

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 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

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 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 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]): 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.

def notFound(fun: ⇒ Any): Unit

final def notify(): Unit

final def notifyAll(): Unit

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

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: (Route) ⇒ Route*)(action: ⇒ Any): Route

implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

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: (Route) ⇒ Route*)(action: ⇒ Any): Route

def readJsonFromBody(bd: String): JValue

def readJsonFromStream(stream: InputStream): JValue

def readXmlFromBody(bd: String): JValue

def readXmlFromStream(stream: InputStream): JValue

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

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): Option[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 requestPath(implicit request: HttpServletRequest): String

def requestScope[A](key: String): Option[A]

Fetches value from request scope.

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

Set attributes to request scope.

def requestScope(keyAndValue: (String, Any)): RequestScopeFeature

Set attribute to request scope.

def requestScope(): Map[String, Any]

Returns whole request scope attributes.

def respondTo: Seq[Format]

Defines formats to be respond.

implicit def response: HttpServletResponse

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

def routeBasePath(implicit request: HttpServletRequest): String

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): TypeConverter[S, T]

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

def scalateExtension: String

Scalate extension name.

implicit def scalatraContext: ScalatraContext

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

implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): 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)]): RequestScopeFeature

Set attributes to request scope.

def set(keyAndValue: (String, Any)): RequestScopeFeature

Set attribute to request scope.

def setAsParams(model: Any): Unit

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

def setCreateCompletionFlash(): Unit

Set notice flash message for successful completion of creation.

def setCurrentLocale(locale: String): Unit

Set current locale.

def setDestroyCompletionFlash(): FlashMap

Set notice flash message for successful completion of deletion.

def setI18n()(implicit locale: Locale = currentLocale.orNull[Locale]): RequestScopeFeature

Set {{skinny.

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

def setParams(): Unit

Set params to request scope.

def setParamsToRequestScope(): Unit

Set params to request scope.

def setUpdateCompletionFlash(): FlashMap

Set notice flash message for successful completion of modification.

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.

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.

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

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

implicit def skinnyValidatorSeqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

implicit def skinnyValidatorSeqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]

implicit val skinnyValidatorStringToBoolean: TypeConverter[String, Boolean]

implicit val skinnyValidatorStringToByte: TypeConverter[String, Byte]

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

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

implicit val skinnyValidatorStringToDouble: TypeConverter[String, Double]

implicit val skinnyValidatorStringToFloat: TypeConverter[String, Float]

implicit val skinnyValidatorStringToInt: TypeConverter[String, Int]

implicit val skinnyValidatorStringToLong: TypeConverter[String, Long]

implicit val skinnyValidatorStringToSelf: TypeConverter[String, String]

def skinnyValidatorStringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

implicit val skinnyValidatorStringToShort: TypeConverter[String, Short]

implicit def skinnyValidator_defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

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

def status: Int

def status_=(code: Int): Unit

implicit def string2RouteMatcher(path: String): RouteMatcher

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: Manifest[T]): TypeConverter[String, Seq[T]]

implicit val stringToShort: TypeConverter[String, Short]

def sweepUnusedFlashEntries(req: HttpServletRequest): Boolean

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

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

def templateAttributes(implicit request: HttpServletRequest): Map[String, Any]

var templateEngine: TemplateEngine

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

Predicates the template path is available.

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

Returns the actual template path for the name.

def toString(): String

implicit def toTypedMultiParams(params: org.scalatra.MultiParams): TypedMultiParams

implicit def toTypedParams(params: org.scalatra.Params): TypedParams

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

def trace(msg: ⇒ Any): Unit

def transformRequestBody(body: JValue): JValue

def transformResponseBody(body: JValue): JValue

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

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

def updateParams: Params

Params for modification.

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

Updates the specified single resource.

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

def useRelativePath: Boolean

Use relative path if true.

def validation(params: Params, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

Creates validator with prefix(resourceName).

def validationWithParams(validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

Creates new validation form.

def validationWithParamsAndPrefix(prefix: String, params: Params, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

Creates new validation form.

def validationWithPrefix(params: Params, prefix: String, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

Creates new validation form.

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

def warn(msg: ⇒ Any): Unit

def withFormat[A](format: Format)(action: ⇒ A): A

Provides code block with format.

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

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

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

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

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

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

def xmlItemName: String

def xmlRootName: String

lazy val xmlRootNode: Elem

def _request: DynamicVariable[HttpServletRequest]

def _response: DynamicVariable[HttpServletResponse]

def applicationContext: javax.servlet.ServletContext

def prepareCSRFToken(): Any

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

def status(code: Int): Unit