t

org.scalatra.swagger

SwaggerAuthSupport

trait SwaggerAuthSupport[TypeForUser <: AnyRef] extends SwaggerSupportBase with SwaggerSupportSyntax

Self Type
SwaggerAuthSupport[TypeForUser] with ScalatraBase with ScentrySupport[TypeForUser]
Linear Supertypes
SwaggerSupportSyntax, CorsSupport, Handler, Initializable, SwaggerSupportBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwaggerAuthSupport
  2. SwaggerSupportSyntax
  3. CorsSupport
  4. Handler
  5. Initializable
  6. SwaggerSupportBase
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef
    Definition Classes
    Initializable
  2. abstract type ConfigT
    Definition Classes
    Initializable
  3. implicit class ResponseMessageWithModel extends AnyRef
    Definition Classes
    SwaggerSupportSyntax

Abstract Value Members

  1. abstract def applicationDescription: String
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  2. implicit abstract def configWrapper(config: (SwaggerAuthSupport.this)#ConfigT): (SwaggerAuthSupport.this)#Config
    Attributes
    protected
    Definition Classes
    Initializable
  3. implicit abstract def swagger: SwaggerEngine[_]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apiOperation(nickname: String, model: Model): AuthOperationBuilder[TypeForUser]
    Attributes
    protected
  5. def apiOperation[T](nickname: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): AuthOperationBuilder[TypeForUser]
    Attributes
    protected
    Definition Classes
    SwaggerAuthSupport → SwaggerSupportSyntax
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def augmentSimpleRequest(): Unit
    Attributes
    protected
    Definition Classes
    CorsSupport
  8. def bodyParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  9. def bodyParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  10. def bodyParam(model: Model): ModelParameterBuilder
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  11. def bodyParam[T](implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. implicit def dataType2string(dt: DataType): String
    Definition Classes
    SwaggerSupportSyntax
  14. def description(f: PartialFunction[String, String]): Unit
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  15. def endpoint(value: String): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  16. def endpoints(basePath: String): List[AuthEndpoint[TypeForUser]]

    Builds the documentation for all the endpoints discovered in an API.

    Builds the documentation for all the endpoints discovered in an API.

    Definition Classes
    SwaggerAuthSupport → SwaggerSupportBase
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def extractOperation(route: Route, method: HttpMethod): AuthOperation[TypeForUser]

    Returns a list of operations based on the given route.

    Returns a list of operations based on the given route. The default implementation returns a list with only 1 operation.

    Attributes
    protected
    Definition Classes
    SwaggerAuthSupport → SwaggerSupportBase
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def formParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  22. def formParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  24. def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

    Handles a request and writes to the response.

    Handles a request and writes to the response.

    Definition Classes
    CorsSupport → Handler
  25. def handlePreflightRequest(): Unit
    Attributes
    protected
    Definition Classes
    CorsSupport
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  27. def headerParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  28. def headerParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  29. def inferSwaggerEndpoint(route: Route): String
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  30. def initialize(config: (SwaggerAuthSupport.this)#ConfigT): Unit

    Initializes the kernel.

    Initializes the kernel. Used to provide context that is unavailable when the instance is constructed, for example the servlet lifecycle. Should set the config variable to the parameter.

    config

    the configuration.

    Definition Classes
    SwaggerSupportSyntax → CorsSupport → Initializable
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def models: Map[String, Model]

    The currently registered model descriptions for swagger

    The currently registered model descriptions for swagger

    returns

    a map of swagger models

    Definition Classes
    SwaggerSupportSyntax
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  36. def operation(op: SwaggerOperation): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  37. implicit def operationBuilder2operation(bldr: SwaggerAuthOperationBuilder[TypeForUser]): AuthOperation[TypeForUser]
    Attributes
    protected
  38. implicit def parameterBuilder2parameter(pmb: SwaggerParameterBuilder): Parameter
    Definition Classes
    SwaggerSupportSyntax
  39. def pathParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  40. def pathParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  41. def queryParam(name: String, model: Model): ModelParameterBuilder
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  42. def queryParam[T](name: String)(implicit arg0: Manifest[T], arg1: NotNothing[T]): ParameterBuilder[T]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  43. def registerModel[T]()(implicit arg0: Manifest[T], arg1: NotNothing[T]): Unit

    Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion

    Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion

    T

    the class of the model to register

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  44. def registerModel(model: Model): Unit

    Registers a model for swagger

    Registers a model for swagger

    model

    the model to add to the swagger definition

    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  45. def shutdown(): Unit

    A hook to shutdown the class.

    A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.

    Attributes
    protected
    Definition Classes
    Initializable
  46. def swaggerAuthorizations: List[String]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  47. def swaggerConsumes: List[String]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  48. def swaggerDefaultMessages: List[ResponseMessage]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  49. def swaggerEndpointEntries[T <: SwaggerOperation](extract: (Route, HttpMethod) ⇒ T): Iterable[Entry[T]]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  50. def swaggerMeta(s: Symbol, v: Any): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  51. def swaggerProduces: List[String]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  52. def swaggerProtocols: List[String]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def allows(value: (Option[TypeForUser]) ⇒ Boolean): RouteTransformer
    Attributes
    protected
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.allows and operation methods to build swagger descriptions of endpoints

  2. def applicationName: Option[String]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.1) This field is no longer used, due to changes in Swagger spec 1.2

  3. def errors(value: Error*): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.errors and operation methods to build swagger descriptions of endpoints

  4. implicit def modelToSwagger(cls: Class[_]): (String, Model)
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) This implicit conversion will be removed in the future

  5. def models_=(m: Map[String, Model]): Map[String, Model]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use registerModel[T] or registerModel(model) instead, this method will be removed in the future

  6. def nickname(value: String): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.nickname and operation methods to build swagger descriptions of endpoints

  7. def notes(value: String): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.notes and operation methods to build swagger descriptions of endpoints

  8. def parameters(value: Parameter*): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.parameters and operation methods to build swagger descriptions of endpoints

  9. def responseClass[T](implicit mf: Manifest[T]): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.responseClass and operation methods to build swagger descriptions of endpoints

  10. def responseClass(value: String): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the variant where you use a type parameter, this method doesn't allow for reflection and requires you to manually ad the model

  11. def summary(value: String): RouteTransformer
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Use the apiOperation.summary and operation methods to build swagger descriptions of endpoints

  12. def swaggerDefaultErrors: List[ResponseMessage]
    Attributes
    protected
    Definition Classes
    SwaggerSupportSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.2) Swagger spec 1.2 renamed this to swaggerDefaultMessages, please use that one

Inherited from SwaggerSupportSyntax

Inherited from CorsSupport

Inherited from Handler

Inherited from Initializable

Inherited from SwaggerSupportBase

Inherited from AnyRef

Inherited from Any

Ungrouped