trait ResourceRouter extends AnyRef
The core interface for the router. Implement this interface in order to be able to route your requests.
Note: typically, a macro implements these functions for individual resources by subclassing one of the types below.
- Alphabetic
- By Inheritance
- ResourceRouter
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
abstract
type
ResourceClass
The resource class this router handles.
Abstract Value Members
-
abstract
def
routeRequest(path: String, requestHeader: RequestHeader): Option[RouteAction]
If the request is for this resource, return a RouteAction.
If the request is for this resource, return a RouteAction. For alternate resources, return None
Note: by returning
Some[RouteAction], that does not mean that there is a valid finder, action, or that all query parameters were parsed correctly.- path
The (modified) request path to use for routing request.
- requestHeader
The request to be handled (for routing & query parameter parsing)
- returns
Either the Play! action to handle the request, or None indicating this request is for a different resource.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()