Packages

p

xitrum

routing

package routing

Content Hierarchy
DotRouteTokenNonDotRouteTokenRouteToken
Ordering
  1. Alphabetic
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
  2. case class DotRouteToken (nonDotRouteTokens: Seq[NonDotRouteToken]) extends RouteToken with Product with Serializable

    "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

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

  4. class ReverseRoute extends AnyRef

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

  5. class Route extends AnyRef

  6. class RouteCollection extends AnyRef

    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
  8. class SerializableRoute extends Serializable
  9. class SerializableRouteCollection extends Serializable
  10. class SockJsClassAndOptions extends Serializable

    "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
  12. class SwaggerJson extends FutureAction
    Annotations
    @First() @GET( paths = "xitrum/swagger.json" )
  13. class SwaggerUi extends FutureAction

    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
  2. object ReverseRoute
  3. object RouteCollection
  4. object RouteCollector

    Scan all classes to collect routes from actions.

  5. object RouteCompiler
  6. object SwaggerJson

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

Ungrouped