SkinnyApiResource

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: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

object WithRendering extends controller.feature.SkinnyControllerCommonBase.RenderingRequired with Product with Serializable

object WithoutRendering extends controller.feature.SkinnyControllerCommonBase.RenderingRequired with Product with Serializable

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

Adds error handler which doesn't return result to SkinnyController.

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

def addParam(name: String, value: Any)(implicit ctx: SkinnyEngineContext = context): Unit

Add param to params in the request scope.

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

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: engine.implicits.TypeConverter[Any, Boolean]

implicit val anyToByte: engine.implicits.TypeConverter[Any, Byte]

implicit val anyToDouble: engine.implicits.TypeConverter[Any, Double]

implicit val anyToFloat: engine.implicits.TypeConverter[Any, Float]

implicit val anyToInt: engine.implicits.TypeConverter[Any, Int]

implicit val anyToLong: engine.implicits.TypeConverter[Any, Long]

implicit val anyToShort: engine.implicits.TypeConverter[Any, Short]

implicit val anyToString: engine.implicits.TypeConverter[Any, String]

final def asInstanceOf[T0]: T0

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

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

lazy val charset: Option[String]

def clone(): AnyRef

def compact(value: JValue): String

var config: ConfigT

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

def contentType(implicit ctx: SkinnyEngineContext): String

def contentTypeInferrer: ContentTypeInferrer

def contentType_=(contentType: String)(implicit ctx: SkinnyEngineContext): Unit

def context: SkinnyEngineContext

def contextPath: String

implicit def convertParamsToStrongParameters(params: engine.Params): StrongParameters

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

implicit def cookieOptions(implicit ctx: SkinnyEngineContext): CookieOptions

def cookies(implicit ctx: SkinnyEngineContext): SweetCookies

def countResources(): Long

def createApiAction: Any

val createApiUrl: Route

def createI18n()(implicit locale: Locale = ...): I18n

Creates skinny.

def createParams: Params

Params for creation.

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

Creates new resource.

def currentActionName(implicit cxt: SkinnyEngineContext = context): Option[Symbol]

Returns action name for this request.

def currentErrorHandler: ErrorHandler

def currentLocale(implicit ctx: SkinnyEngineContext): Option[Locale]

Returns current locale for this request.

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 defaultLocale: Option[Locale]

Returns default locale.

def defaultObjectMapper: ObjectMapper

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

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

def deleteApiAction: Any

def destroy(): Unit

val destroyApiUrl: Route

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

Destroys the specified resource.

def detectTooManyErrorFilterRegistrationAsAnErrorAtSkinnyEngineBase: Boolean

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

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

Executes modification for the specified resource.

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

def environment: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(handler: ErrorHandler): Unit

def errorMessages(implicit ctx: SkinnyEngineContext = context): Seq[String]

Returns errorMessages in the RequestScope.

def executeRoutes(request: HttpServletRequest, response: HttpServletResponse): Unit

implicit def executionContext: ExecutionContext

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 formMultiParams(implicit ctx: SkinnyEngineContext): engine.MultiParams

Returns query string multi parameters as a Map value.

def formParams(implicit ctx: SkinnyEngineContext): engine.Params

Returns query string parameters as a Map value.

def format(implicit ctx: SkinnyEngineContext): String

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

def format_=(formatValue: String)(implicit ctx: SkinnyEngineContext): Unit

val formats: Map[String, String]

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

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

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

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

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

final def getClass(): Class[_]

def getFromRequestScope[A](key: String)(implicit ctx: SkinnyEngineContext = context): 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 ctx: SkinnyEngineContext, format: engine.Format = Format.HTML): A

Halts with body which responds to the specified format.

def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

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

def inferFromFormats: ContentTypeInferrer

def init(filterConfig: FilterConfig): Unit

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

def initialize(config: ConfigT): Unit

def initializeRequestScopeAttributes(implicit ctx: SkinnyEngineContext = context): Any

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

def isAsyncExecutable(result: Any): Boolean

def isDevelopment(): Boolean

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

def isDevelopmentMode: Boolean

Replaces Scalatra's development mode with SkinnyEnv.

final def isInstanceOf[T0]: Boolean

def isProduction(): Boolean

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

def isStaging(): Boolean

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

def isTest(): Boolean

Predicates current env is "test".

implicit val jsonFormats: Formats

def keyAndErrorMessages(implicit ctx: SkinnyEngineContext = context): Map[String, Seq[String]]

Returns keyAndErrorMessages in the RequestScope.

def logger: Logger

def loggerName: String

implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): engine.implicits.TypeConverter[Any, T]

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

val mimeTypes: Map[String, String]

def mount(ctx: javax.servlet.ServletContext): Unit

def multiParams(key: String)(implicit ctx: SkinnyEngineContext): Seq[String]

def multiParams(implicit ctx: SkinnyEngineContext): engine.MultiParams

final def ne(arg0: AnyRef): Boolean

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

def params(implicit ctx: SkinnyEngineContext): engine.Params

def params(key: Symbol)(implicit ctx: SkinnyEngineContext): String

def params(key: String)(implicit ctx: SkinnyEngineContext): String

def pass(): Nothing

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

implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

def prefixForJSONVulnerabilityProtection: String

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

def queryMultiParams(implicit ctx: SkinnyEngineContext): engine.MultiParams

Returns query string multi parameters as a Map value.

def queryParams(implicit ctx: SkinnyEngineContext): engine.Params

Returns query string parameters as a Map value.

def redirect(uri: String)(implicit ctx: SkinnyEngineContext): Nothing

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

Responds as "301 Moved Permanently"

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

Responds as "302 Found"

def redirect303(location: String, headers: Map[String, String] = Map.empty, reason: String = "")(implicit ctx: SkinnyEngineContext = context): 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 ctx: SkinnyEngineContext): String

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

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

def renderHaltException(e: HaltException)(implicit ctx: SkinnyEngineContext): Unit

def renderPipeline(implicit ctx: SkinnyEngineContext): RenderPipeline

def renderResponse(actionResult: Any)(implicit ctx: SkinnyEngineContext): Unit

def renderResponseBody(actionResult: Any)(implicit ctx: SkinnyEngineContext): Unit

def renderUncaughtException(e: Throwable)(implicit ctx: SkinnyEngineContext): Unit

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

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

def request(implicit ctx: SkinnyEngineContext): HttpServletRequest

def requestFormat(implicit ctx: SkinnyEngineContext): String

def requestPath(implicit ctx: SkinnyEngineContext): String

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

Set attributes to request scope.

def requestScope(keyAndValue: (String, Any))(implicit ctx: SkinnyEngineContext): RequestScopeFeature

Set attribute to request scope.

def requestScope(implicit ctx: SkinnyEngineContext = context): Map[String, Any]

Returns whole request scope attributes.

def resourcesBasePath: String

Base path.

def resourcesBasePathPrefix: String

Base path prefix.

def respondTo: Seq[engine.Format]

def response(implicit ctx: SkinnyEngineContext): HttpServletResponse

def responseAsJSON(entity: Any, charset: Option[String], prettify: Boolean, underscoreKeys: Boolean)(implicit ctx: SkinnyEngineContext): String

def routeBasePath(implicit ctx: SkinnyEngineContext): String

def routeForShowApi: Route

val routes: RouteRegistry

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

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

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

implicit val scalatraParamsIdTypeConverter: engine.implicits.TypeConverter[String, Long]

to enable params.

def sensitiveParameterNames: Seq[String]

Returns registered sensitive parameter names.

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

implicit def seqToSeq[T](implicit elementConverter: engine.implicits.TypeConverter[String, T], mf: Manifest[T]): engine.implicits.TypeConverter[Seq[String], Seq[T]]

def serverAuthority(implicit ctx: SkinnyEngineContext): String

def serverHost(implicit ctx: SkinnyEngineContext): String

def serverPort(implicit ctx: SkinnyEngineContext): Int

implicit def servletContext: javax.servlet.ServletContext

def session(key: Symbol)(implicit ctx: SkinnyEngineContext): Any

def session(key: String)(implicit ctx: SkinnyEngineContext): Any

implicit def session(implicit ctx: SkinnyEngineContext): HttpSession

def sessionLocaleKey: String

Session key to store current locale string.

def sessionOption(implicit ctx: SkinnyEngineContext): Option[HttpSession]

def set(keyAndValues: Seq[(String, Any)])(implicit ctx: SkinnyEngineContext): RequestScopeFeature

Set attributes to request scope.

def set(keyAndValue: (String, Any))(implicit ctx: SkinnyEngineContext): RequestScopeFeature

Set attribute to request scope.

def setAsParams(model: Any)(implicit ctx: SkinnyEngineContext = context): 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: engine.Format = Format.HTML): Unit

Set Content-Type for the format if absent.

def setCurrentLocale(locale: String)(implicit ctx: SkinnyEngineContext): Unit

Set current locale.

def setI18n(implicit ctx: SkinnyEngineContext = context): RequestScopeFeature

Set {{skinny.

def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: engine.MultiParams)(implicit ctx: SkinnyEngineContext): Unit

def setParams(implicit ctx: SkinnyEngineContext = context): Unit

Set params to request scope.

def setParamsToRequestScope(implicit ctx: SkinnyEngineContext = context): Unit

Set params to request scope.

def showApiAction: Any

val showApiUrl: 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.

def shutdown(): Unit

implicit val skinnyController: SkinnyControllerCommonBase

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

implicit def skinnyEngineContext(implicit ctx: javax.servlet.ServletContext): SkinnyEngineContext

def skinnyEnv: Option[String]

Env string value from "skinny.

lazy val skinnyErrorFilters: TrieMap[RenderingRequired, Seq[ErrorHandler]]

Registered error handlers.

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

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

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

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

implicit val skinnyValidatorStringToBoolean: ParamValueTypeConverter[String, Boolean]

implicit val skinnyValidatorStringToByte: ParamValueTypeConverter[String, Byte]

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

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

implicit val skinnyValidatorStringToDouble: ParamValueTypeConverter[String, Double]

implicit val skinnyValidatorStringToFloat: ParamValueTypeConverter[String, Float]

implicit val skinnyValidatorStringToInt: ParamValueTypeConverter[String, Int]

implicit val skinnyValidatorStringToLong: ParamValueTypeConverter[String, Long]

implicit val skinnyValidatorStringToSelf: ParamValueTypeConverter[String, String]

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

implicit val skinnyValidatorStringToShort: ParamValueTypeConverter[String, Short]

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

def stackTraceDepthForTimeLogging: Int

def status(implicit ctx: SkinnyEngineContext): Int

def status_=(code: Int)(implicit ctx: SkinnyEngineContext): Unit

implicit def string2RouteMatcher(path: String): RouteMatcher

implicit val stringToBoolean: engine.implicits.TypeConverter[String, Boolean]

implicit val stringToByte: engine.implicits.TypeConverter[String, Byte]

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

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

implicit val stringToDouble: engine.implicits.TypeConverter[String, Double]

implicit val stringToFloat: engine.implicits.TypeConverter[String, Float]

implicit val stringToInt: engine.implicits.TypeConverter[String, Int]

implicit val stringToLong: engine.implicits.TypeConverter[String, Long]

implicit def stringToRicherString(s: String): RicherString

implicit val stringToSelf: engine.implicits.TypeConverter[String, String]

def stringToSeq[T](elementConverter: engine.implicits.TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): engine.implicits.TypeConverter[String, Seq[T]]

implicit val stringToShort: engine.implicits.TypeConverter[String, Short]

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

def toJSON(v: Any): JValue

def toJSONString(v: Any, underscoreKeys: Boolean): String

def toJSONStringAsIs(v: Any): String

def toPrettyJSONString(v: Any, underscoreKeys: Boolean): String

def toPrettyJSONStringAsIs(v: Any): String

def toSnakeCase(s: String): String

Converts string value to snake_case'd value.

def toString(): String

implicit def toTypedMultiParams(params: engine.MultiParams): TypedMultiParams

implicit def toTypedParams(params: engine.Params): TypedParams

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

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

def unstableAccessValidationEnabled: Boolean

def updateApiAction: Any

def updateParams: Params

Params for modification.

val updatePatchApiUrl: Route

val updatePostApiUrl: Route

val updatePutApiUrl: Route

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

Updates the specified single resource.

def url(route: Route, params: Map[String, String], splats: Iterable[String])(implicit ctx: SkinnyEngineContext): String

def url(route: Route, splat: String, moreSplats: String*)(implicit ctx: SkinnyEngineContext): String

def url(route: Route, params: (String, String)*)(implicit ctx: SkinnyEngineContext): String

def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit ctx: SkinnyEngineContext): String

def useJSONVulnerabilityProtection: Boolean

def useRelativePathForResourcesBasePath: Boolean

Use relative path if true.

def useSnakeCasedParamKeys: Boolean

Defines use snake_case'd keys.

def useUnderscoreKeysForJSON: Boolean

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

Creates validator with prefix(resourceName).

def validationWithParams(validations: NewValidation*)(implicit locale: Locale = ...): MapValidator

Creates new validation form.

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

Creates new validation form.

def validationWithPrefix(params: Params, prefix: String, validations: NewValidation*)(implicit ctx: SkinnyEngineContext): MapValidator

Creates new validation form.

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def warnElapsedTime[A](millis: Long, additionalLines: ⇒ Seq[String])(action: ⇒ A): A

def warnElapsedTimeWithRequest[A](millis: Long, additionalLines: Seq[String] = Nil)(action: ⇒ A)(implicit context: SkinnyEngineContext): A

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

Provides code block with format.

def withOutputStream(f: (ServletOutputStream) ⇒ Unit): Unit

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 writeChunk(chunk: Array[Byte])(implicit stream: ServletOutputStream = response.getOutputStream): Unit

def xmlItemName: String

Each resource item element name in the XML response.

def xmlRootName: String

Root element name in the XML response.

def responseFormat(implicit ctx: SkinnyEngineContext): String