Trait

org.scalatra.swagger

SwaggerAuthBase

Related Doc: package swagger

Permalink

trait SwaggerAuthBase[TypeForUser <: AnyRef] extends SwaggerBaseBase

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

Type Members

  1. type ApiType = AuthApi[TypeForUser]

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerAuthBaseSwaggerBaseBase
  2. trait Config extends AnyRef

    Permalink
    Definition Classes
    Initializable
  3. abstract type ConfigT

    Permalink
    Definition Classes
    Initializable
  4. implicit class JsonAssocNonEmpty extends AnyRef

    Permalink
    Definition Classes
    SwaggerBaseBase

Abstract Value Members

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

    Permalink
    Attributes
    protected
    Definition Classes
    Initializable
  2. abstract val doNotFound: Action

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  3. abstract def requestPath(implicit request: HttpServletRequest): String

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

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  5. implicit abstract def swagger: SwaggerEngine[AuthApi[AnyRef]]

    Permalink

    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
    Definition Classes
    SwaggerAuthBaseSwaggerBaseBase
  6. abstract def userManifest: Manifest[TypeForUser]

    Permalink
    Attributes
    protected

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  8. implicit val anyToBoolean: TypeConverter[Any, Boolean]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LowPriorityImplicitConversions
  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. def bathPath: Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
  18. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  19. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

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

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

    Permalink
    Definition Classes
    ScalatraBase
  22. def contentType: String

    Permalink
    Definition Classes
    ScalatraContext
  23. def contentTypeInferrer: ContentTypeInferrer

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

    Permalink
    Definition Classes
    ScalatraContext
  25. def contextPath: String

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  26. implicit def cookieOptions: CookieOptions

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

    Permalink
    Definition Classes
    CookieContext
  28. val defaultCharacterEncoding: String

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

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  31. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  32. def docToJson(doc: (SwaggerAuthBase.this)#ApiType): JValue

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

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

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

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

    Permalink
    Definition Classes
    ServletApiImplicits
  37. def environment: String

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

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

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  41. var errorHandler: ErrorHandler

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  44. def filterDoc(doc: AuthApi[AnyRef]): AuthApi[AnyRef]

    Permalink
    Attributes
    protected
  45. def filterDocs(docs: Iterable[AuthApi[AnyRef]]): Iterable[AuthApi[AnyRef]]

    Permalink
    Attributes
    protected
  46. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  51. final def getClass(): Class[_]

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

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  57. def includeFormatParameter: Boolean

    Permalink

    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
    Definition Classes
    SwaggerBaseBase
  58. def indexRoute: String

    Permalink

    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 /

    returns

    The name of the route

    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
  59. def initParameter(name: String): Option[String]

    Permalink
    Definition Classes
    ScalatraBase
  60. def initialize(config: (SwaggerAuthBase.this)#ConfigT): Unit

    Permalink
    Definition Classes
    SwaggerAuthBaseSwaggerBaseBase → ScalatraBase → Initializable
  61. def invoke(matchedRoute: MatchedRoute): Option[Any]

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

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  63. def isDevelopmentMode: Boolean

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

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

    Permalink
    Definition Classes
    Any
  66. implicit def jsonFormats: Formats

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerAuthBaseSwaggerBaseBase
  67. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]

    Permalink
    Definition Classes
    LowestPriorityImplicitConversions
  68. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  69. def multiParams(implicit request: HttpServletRequest): MultiParams

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

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

    Permalink
    Definition Classes
    AnyRef
  72. def needsHttps: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  73. def notFound(fun: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  74. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  75. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  77. def params(implicit request: HttpServletRequest): Params

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

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

    Permalink
    Definition Classes
    ScalatraBase
  80. def pass(): Nothing

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  82. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  84. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  85. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  90. def renderHaltException(e: HaltException): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  91. def renderPipeline: RenderPipeline

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  94. def renderSwagger2(docs: List[(SwaggerAuthBase.this)#ApiType]): JValue

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
  95. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ScalatraBase
  96. implicit def request: HttpServletRequest

    Permalink
    Definition Classes
    DynamicScope → RequestResponseScope
  97. implicit def response: HttpServletResponse

    Permalink
    Definition Classes
    DynamicScope → RequestResponseScope
  98. lazy val routes: RouteRegistry

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

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

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

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

    Permalink
    Definition Classes
    TypeConverterSupport
  103. implicit def scalatraContext: ScalatraContext

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

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

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

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

    Permalink
    Definition Classes
    ScalatraBase
  108. def servletContext: ServletContext

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Initializable
  115. def status: Int

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  130. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  131. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams

    Permalink
    Definition Classes
    ScalatraParamsImplicits
  132. implicit def toTypedParams(params: Params): TypedParams

    Permalink
    Definition Classes
    ScalatraParamsImplicits
  133. def trap(codes: Range)(block: ⇒ Any): Unit

    Permalink
    Definition Classes
    ScalatraBase → CoreDsl
  134. def trap(code: Int)(block: ⇒ Any): Unit

    Permalink
    Definition Classes
    CoreDsl
  135. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Permalink
    Definition Classes
    ScalatraBase
  136. final def wait(): Unit

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

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

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

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

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

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

    Permalink
    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase

Deprecated Value Members

  1. def renderDoc(doc: (SwaggerAuthBase.this)#ApiType): JValue

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Swagger 1.x support will be dropped in Scalatra 2.7.0

  2. def renderIndex(docs: List[(SwaggerAuthBase.this)#ApiType]): JValue

    Permalink
    Attributes
    protected
    Definition Classes
    SwaggerBaseBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Swagger 1.x support will be dropped in Scalatra 2.7.0

Inherited from SwaggerBaseBase

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