Route

Represents an element which can be routed to via the admin http server.

path: The path used to access the route. A request is routed to the path as per the com.twitter.finagle.http.HttpMuxer spec.
handler: The service which requests are routed to.
alias: A short name used to identify the route when listed in index.
group: A grouping used to organize the route in the admin server pages. Routes with the same grouping are displayed together in the admin server pages.
includeInIndex: Indicates whether the route is included as part of the admin server index.
method: Specifies which HTTP Method to use from com.twitter.finagle.http.Method. The default is Method.Get.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Route(path: String, handler: Service[Request, Response], alias: String, group: Option[String], includeInIndex: Boolean, method: Method = Method.Get)

path
The path used to access the route. A request is routed to the path as per the com.twitter.finagle.http.HttpMuxer spec.
handler
The service which requests are routed to.
alias
A short name used to identify the route when listed in index.
group
A grouping used to organize the route in the admin server pages. Routes with the same grouping are displayed together in the admin server pages.
includeInIndex
Indicates whether the route is included as part of the admin server index.
method
Specifies which HTTP Method to use from com.twitter.finagle.http.Method. The default is Method.Get.

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
val alias: String

A short name used to identify the route when listed in index.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val group: Option[String]

A grouping used to organize the route in the admin server pages.
A grouping used to organize the route in the admin server pages. Routes with the same grouping are displayed together in the admin server pages.
val handler: Service[Request, Response]

The service which requests are routed to.
val includeInIndex: Boolean

Indicates whether the route is included as part of the admin server index.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val method: Method

Specifies which HTTP Method to use from com.twitter.finagle.http.Method.
Specifies which HTTP Method to use from com.twitter.finagle.http.Method. The default is Method.Get.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: String

The path used to access the route.
The path used to access the route. A request is routed to the path as per the com.twitter.finagle.http.HttpMuxer spec.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

Related Docs: object Route | package AdminHttpServer

case class Route(path: String, handler: Service[Request, Response], alias: String, group: Option[String], includeInIndex: Boolean, method: Method = Method.Get) extends Product with Serializable

Instance Constructors

new Route(path: String, handler: Service[Request, Response], alias: String, group: Option[String], includeInIndex: Boolean, method: Method = Method.Get)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val alias: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val group: Option[String]

val handler: Service[Request, Response]

val includeInIndex: Boolean

final def isInstanceOf[T0]: Boolean

val method: Method

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: String

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped