Package

xitrum

routing

Permalink

package routing

Content Hierarchy
Visibility
  1. Public
  2. All

Type Members

  1. case class DiscoveredAcc(xitrumVersion: String, normalRoutes: SerializableRouteCollection, sockJsWithoutPrefixRoutes: SerializableRouteCollection, sockJsMap: Map[String, SockJsClassAndOptions], swaggerMap: Map[Class[_ <: Action], Swagger]) extends Product with Serializable

    Permalink
  2. case class DotRouteToken(nonDotRouteTokens: Seq[NonDotRouteToken]) extends RouteToken with Product with Serializable

    Permalink

    "articles/:id<[0-9]+>.:format" gives 2 tokens: - NonDotRouteToken("articles", false, None) - DotRouteToken(Seq(NonDotRouteToken("id", true, Some("[0-9]+".r)), NonDotRouteToken("format", true, None)))

  3. case class NonDotRouteToken(value: String, isPlaceholder: Boolean, regex: Option[Regex]) extends RouteToken with Product with Serializable

    Permalink

    "articles/:id<[0-9]+>" gives 2 tokens: - NonDotRouteToken("articles", false, None) - NonDotRouteToken("id", true, Some("[0-9]+".r))

  4. class ReverseRoute extends AnyRef

    Permalink

    Routes are sorted reveresly by the number of placeholders because we want to fill as many placeholders as possible.

  5. class Route extends AnyRef

    Permalink

  6. class RouteCollection extends AnyRef

    Permalink

    Routes are grouped by methods.

    Routes are grouped by methods. The routes are ArrayBuffer so that routes can be modified after collected.

  7. sealed trait RouteToken extends AnyRef

    Permalink
  8. class SerializableRoute extends Serializable

    Permalink
  9. class SerializableRouteCollection extends Serializable

    Permalink
  10. class SockJsClassAndOptions extends Serializable

    Permalink

    "websocket" and "cookieNeeded" members are named after SockJS options, ex: {"websocket": true, "cookie_needed": false, "origins": ["*:*"], "entropy": 123}

    "websocket" and "cookieNeeded" members are named after SockJS options, ex: {"websocket": true, "cookie_needed": false, "origins": ["*:*"], "entropy": 123}

    - websocket: true means WebSocket is enabled - cookieNeeded: true means load balancers needs JSESSION cookie

  11. class SockJsRouteMap extends AnyRef

    Permalink
  12. class SwaggerJson extends FutureAction

    Permalink
    Annotations
    @First() @GET( paths = "xitrum/swagger.json" )
  13. class SwaggerUi extends FutureAction

    Permalink

    Easy-to-remember path to Swagger UI: /xitrum/swagger

    Easy-to-remember path to Swagger UI: /xitrum/swagger

    Annotations
    @First() @GET( paths = "xitrum/swagger" )

Value Members

  1. object HttpMethodWebSocket extends HttpMethod

    Permalink
  2. object ReverseRoute

    Permalink
  3. object RouteCollection

    Permalink
  4. object RouteCollector

    Permalink

    Scan all classes to collect routes from actions.

  5. object RouteCompiler

    Permalink
  6. object SwaggerJson

    Permalink

    https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md

Ungrouped