org.scalatra.swagger

SwaggerBaseBase

trait SwaggerBaseBase extends Initializable with ScalatraBase

Trait that serves the resource and operation listings, as specified by the Swagger specification.

Self Type
SwaggerBaseBase with JsonSupport[_] with CorsSupport
Linear Supertypes
ScalatraBase, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, Initializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwaggerBaseBase
  2. ScalatraBase
  3. DefaultImplicitConversions
  4. LowPriorityImplicitConversions
  5. LowestPriorityImplicitConversions
  6. TypeConverterSupport
  7. ScalatraParamsImplicits
  8. DynamicScope
  9. RequestResponseScope
  10. CoreDsl
  11. Control
  12. Handler
  13. ScalatraContext
  14. CookieContext
  15. SessionSupport
  16. ServletApiImplicits
  17. Initializable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type ApiType <: SwaggerApi[_]

    Attributes
    protected
  2. trait Config extends AnyRef

    Definition Classes
    Initializable
  3. abstract type ConfigT

    Definition Classes
    Initializable
  4. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  5. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. implicit abstract def configWrapper(config: (SwaggerBaseBase.this)#ConfigT): (SwaggerBaseBase.this)#Config

    Attributes
    protected
    Definition Classes
    Initializable
  2. abstract val doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  3. abstract def docToJson(doc: (SwaggerBaseBase.this)#ApiType): JValue

    Attributes
    protected
  4. implicit abstract def jsonFormats: Formats

    Attributes
    protected
  5. abstract def requestPath(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  6. abstract def routeBasePath(implicit request: HttpServletRequest): String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  7. implicit abstract def swagger: SwaggerEngine[_ <: SwaggerApi[_]]

    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
    protected

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  7. def addSessionId(uri: String)(implicit response: HttpServletResponse): String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  8. def addStatusRoute(codes: Range, action: ⇒ Any): Unit

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase
  9. def after(transformers: RouteTransformer*)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  10. implicit val anyToBoolean: TypeConverter[Any, Boolean]

    Definition Classes
    LowPriorityImplicitConversions
  11. implicit val anyToByte: TypeConverter[Any, Byte]

    Definition Classes
    LowPriorityImplicitConversions
  12. implicit val anyToDouble: TypeConverter[Any, Double]

    Definition Classes
    LowPriorityImplicitConversions
  13. implicit val anyToFloat: TypeConverter[Any, Float]

    Definition Classes
    LowPriorityImplicitConversions
  14. implicit val anyToInt: TypeConverter[Any, Int]

    Definition Classes
    LowPriorityImplicitConversions
  15. implicit val anyToLong: TypeConverter[Any, Long]

    Definition Classes
    LowPriorityImplicitConversions
  16. implicit val anyToShort: TypeConverter[Any, Short]

    Definition Classes
    LowPriorityImplicitConversions
  17. implicit val anyToString: TypeConverter[Any, String]

    Definition Classes
    LowPriorityImplicitConversions
  18. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  19. def before(transformers: RouteTransformer*)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  20. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  21. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. var config: (SwaggerBaseBase.this)#ConfigT

    Definition Classes
    ScalatraBase
  23. def contentType: String

    Definition Classes
    ScalatraContext
  24. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ScalatraBase
  25. def contentType_=(contentType: String): Unit

    Definition Classes
    ScalatraContext
  26. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  27. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext
  28. def cookies(implicit request: HttpServletRequest): SweetCookies

    Definition Classes
    CookieContext
  29. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  30. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  31. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  32. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  33. implicit def enrichRequest(request: HttpServletRequest): RichRequest

    Definition Classes
    ServletApiImplicits
  34. implicit def enrichResponse(response: HttpServletResponse): RichResponse

    Definition Classes
    ServletApiImplicits
  35. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

    Definition Classes
    ServletApiImplicits
  36. implicit def enrichSession(session: HttpSession): RichSession

    Definition Classes
    ServletApiImplicits
  37. def environment: String

    Definition Classes
    ScalatraBase
  38. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  40. def error(handler: ErrorHandler): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  41. var errorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ScalatraBase
  42. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  43. def extractStatusCode(e: HaltException): Int

    Attributes
    protected
    Definition Classes
    ScalatraBase
  44. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. def format_=(formatValue: String): Unit

    Definition Classes
    ScalatraContext
  46. def format_=(formatValue: Symbol): Unit

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

    Definition Classes
    ScalatraBase
  48. def get(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  49. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  50. def halt(result: ActionResult): Nothing

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

    Definition Classes
    Control
  52. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Definition Classes
    ScalatraBase → Handler
  53. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  54. def head(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  55. 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.

    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.

    returns

    true if the format parameter should be included in the returned json

    Attributes
    protected
  56. def indexRoute: String

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

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

    returns

    The name of the route

    Attributes
    protected
  57. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraBase
  58. def initialize(config: (SwaggerBaseBase.this)#ConfigT): Unit

    Definition Classes
    SwaggerBaseBase → ScalatraBase → Initializable
  59. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Attributes
    protected
    Definition Classes
    ScalatraBase
  60. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  61. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraBase
  62. def isHttps(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  63. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  64. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]

    Definition Classes
    LowestPriorityImplicitConversions
  65. def methodNotAllowed(block: (Set[HttpMethod]) ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  66. def multiParams(implicit request: HttpServletRequest): MultiParams

    Definition Classes
    ScalatraBase
  67. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

    Definition Classes
    ScalatraBase
  68. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  69. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  70. def notFound(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  71. final def notify(): Unit

    Definition Classes
    AnyRef
  72. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  73. def options(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  74. def params(implicit request: HttpServletRequest): Params

    Definition Classes
    ScalatraBase
  75. def params(key: Symbol)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  76. def params(key: String)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  77. def pass(): Nothing

    Definition Classes
    Control
  78. def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  79. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  80. def post(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  81. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  82. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

    Definition Classes
    ScalatraBase
  83. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  84. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase
  85. def removeRoute(method: String, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  86. def removeRoute(method: HttpMethod, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  87. def renderDoc(doc: (SwaggerBaseBase.this)#ApiType): JValue

    Attributes
    protected
  88. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  89. def renderIndex(docs: List[(SwaggerBaseBase.this)#ApiType]): JValue

    Attributes
    protected
  90. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    ScalatraBase
  91. def renderResponse(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  92. def renderResponseBody(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  93. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  94. implicit def request: HttpServletRequest

    Definition Classes
    DynamicScope → RequestResponseScope
  95. implicit def response: HttpServletResponse

    Definition Classes
    DynamicScope → RequestResponseScope
  96. lazy val routes: RouteRegistry

    Definition Classes
    ScalatraBase
  97. def runFilters(filters: Traversable[Route]): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  98. def runRoutes(routes: Traversable[Route]): Stream[Any]

    Attributes
    protected
    Definition Classes
    ScalatraBase
  99. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  100. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  101. implicit def scalatraContext: ScalatraContext

    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  102. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

    Definition Classes
    DefaultImplicitConversions
  103. implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  104. def serverHost(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  105. def serverPort(implicit request: HttpServletRequest): Int

    Definition Classes
    ScalatraBase
  106. def servletContext: ServletContext

    Definition Classes
    ScalatraBase → ScalatraContext
  107. def session(key: Symbol)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport
  108. def session(key: String)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport
  109. implicit def session(implicit request: HttpServletRequest): HttpSession

    Definition Classes
    SessionSupport
  110. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

    Definition Classes
    SessionSupport
  111. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  112. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  113. def status: Int

    Definition Classes
    ScalatraContext
  114. def status_=(code: Int): Unit

    Definition Classes
    ScalatraContext
  115. implicit def string2RouteMatcher(path: String): RailsRouteMatcher

    Definition Classes
    SwaggerBaseBase → ScalatraBase
  116. implicit val stringToBoolean: TypeConverter[String, Boolean]

    Definition Classes
    DefaultImplicitConversions
  117. implicit val stringToByte: TypeConverter[String, Byte]

    Definition Classes
    DefaultImplicitConversions
  118. def stringToDate(format: ⇒ String): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  119. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  120. implicit val stringToDouble: TypeConverter[String, Double]

    Definition Classes
    DefaultImplicitConversions
  121. implicit val stringToFloat: TypeConverter[String, Float]

    Definition Classes
    DefaultImplicitConversions
  122. implicit val stringToInt: TypeConverter[String, Int]

    Definition Classes
    DefaultImplicitConversions
  123. implicit val stringToLong: TypeConverter[String, Long]

    Definition Classes
    DefaultImplicitConversions
  124. implicit val stringToSelf: TypeConverter[String, String]

    Definition Classes
    DefaultImplicitConversions
  125. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  126. implicit val stringToShort: TypeConverter[String, Short]

    Definition Classes
    DefaultImplicitConversions
  127. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  128. def toString(): String

    Definition Classes
    AnyRef → Any
  129. implicit def toTypedMultiParams(params: MultiParams): (SwaggerBaseBase.this)#TypedMultiParams

    Definition Classes
    ScalatraParamsImplicits
  130. implicit def toTypedParams(params: Params): (SwaggerBaseBase.this)#TypedParams

    Definition Classes
    ScalatraParamsImplicits
  131. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  132. def trap(codes: Range)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase
    Annotations
    @macroImpl( ... )
  133. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase
  134. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  138. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected[org.scalatra]
    Definition Classes
    DynamicScope → RequestResponseScope
  139. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  140. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S)(implicit request: HttpServletRequest): S

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase

Deprecated Value Members

  1. def _request: DynamicVariable[HttpServletRequest]

    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withRequest to change the binding, or request to get the value

  2. def _response: DynamicVariable[HttpServletResponse]

    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withResponse to change the binding, or response to get the value

  3. def applicationContext: ServletContext

    Definition Classes
    ScalatraBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  4. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use status_=(Int) instead

Inherited from ScalatraBase

Inherited from DefaultImplicitConversions

Inherited from LowPriorityImplicitConversions

Inherited from LowestPriorityImplicitConversions

Inherited from TypeConverterSupport

Inherited from ScalatraParamsImplicits

Inherited from DynamicScope

Inherited from RequestResponseScope

Inherited from CoreDsl

Inherited from Control

Inherited from Handler

Inherited from ScalatraContext

Inherited from CookieContext

Inherited from SessionSupport

Inherited from ServletApiImplicits

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped