o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
The path end combinator creates a handler that is defined only for paths that are fully matched.
The path end combinator creates a handler that is defined only for paths that are fully matched.
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
The accept combinator creates a handler that is defined only for requests that have the specified content type.
The accept combinator creates a handler that is defined only for requests that have the specified content type. Requires an implicit bijection used for transcoding.
This method is used to cast the receiver object to be of type T0.
This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as
part of compilation it is not possible to check whether the contents of the list are of the requested typed.
the receiver object.
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
Converts a full request handler into a partial request handler that handles every input.
Converts a full request handler into a partial request handler that handles every input. Note: This is an implicit and will automatically convert all full request handlers into partial request handlers, as required by type signatures.
Forces a particular combinator to match.
Forces a particular combinator to match.
commit(r => BadRequest -> "Bad path: " + r.path) {
path("/foo") {
...
}
}Augments the service with a configurable root path.
Augments the service with a configurable root path. If this combinator is used, the config for the service may contain a "rootPath" setting, which is used as the root path for the service.
configurableRoot {
request { state =>
...
}
}
The content type combinator creates a handler that accepts and produces requests and responses of the specified content type.
The content type combinator creates a handler that accepts and produces requests and responses of the specified content type. Requires an implicit bijection used for transcoding.
A special-case extractor for cookie supporting a default value.
A special-case extractor for cookie supporting a default value.
cookie('token, "defaultValue") { token =>
get {
...
}
}A special-case extractor for cookie.
A special-case extractor for cookie.
cookie('token) { token =>
get {
...
}
}This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
* null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence
relation]:
* It is reflexive: for any instance x of type Any, x.equals(x) should return true.
* It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and
only if y.equals(x) returns true.
* It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and
y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects
that are "equal" (o1.equals(o2) returns true) hash to the same
scala.Int
(o1.hashCode.equals(o2.hashCode)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
Extracts data from the request.
Extracts data from the request. The extractor combinators can be used to factor out extraction logic that's duplicated across a range of handlers.
Extractors are fail-fast combinators. If they cannot extract the required information during evaluation of isDefinedAt() method, they immediately throw an HttpException.
extract(_.parameters('username)) { username =>
...
}This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
Creates a handler that accepts ranged GET requests.
Creates a handler that accepts ranged GET requests. A ranged GET request uses the Range header with the following syntax: [unit]=[lower-bound]-[upper-bound]. For example, bytes=0-123, indices=0-23.
getRange { (ranges, unit) =>
(unit, ranges) match {
case ("indices", (lowerBound, upperBound) :: Nil) =>
// Retrieve all elements from lowerBound to upperBound
}
}
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
the hash code value for the object.
Augments the service with health monitoring.
Augments the service with health monitoring. By default, various metrics relating to request type, request timing, and request fulfillment are exported to the health monitor.
healthMonitor { monitor =>
request { state =>
...
}
}
This method is used to test whether the dynamic type of the receiver object is T0.
This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will
return true. In the latter example, because the type argument is erased as part of compilation it is not
possible to check whether the contents of the list are of the requested typed.
true if the receiver object is an instance of erasure of type T0; false otherwise.
The jsonp combinator creates a handler that accepts and produces JSON.
The jsonp combinator creates a handler that accepts and produces JSON. The handler also transparently works with JSONP, if the client specifies a "callback" parameter in the query string. Clients may encode both HTTP method and content using the query string parameters "method" and "content", respectively.
Attemps to peek to see if a particular handler will handle a request.
Attemps to peek to see if a particular handler will handle a request. Used to convert a fast-failing handler into a skipping one.
justTry {
path("/foo") {
...
}
}The json combinator creates a handler that accepts and produces JSON.
The json combinator creates a handler that accepts and produces JSON. Requires an implicit bijection used for transcoding.
Augments the service with logging.
Augments the service with logging.
logging { logger =>
request { state =>
...
}
}
The method combinator creates a handler that is defined only for the specified HTTP method.
The method combinator creates a handler that is defined only for the specified HTTP method.
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
path("/foo") {
.
path("/foo") {
...
} ~ orFail("The path is malformed")
definition classes: HttpRequestHandlerCombinators
path("/foo") {
.
path("/foo") {
...
} ~ orFail { request => BadRequest -> "The path " + request.path + " is malformed" }
definition classes: HttpRequestHandlerCombinators
A special-case extractor for parameters.
A special-case extractor for parameters.
parameter('token) { token =>
get {
...
}
}The path combinator creates a handler that is defined only for suffixes of the specified path pattern.
The path combinator creates a handler that is defined only for suffixes of the specified path pattern.
path("/foo") {
...
}
The produce combinator creates a handler that is produces responses that have the specified content type.
The produce combinator creates a handler that is produces responses that have the specified content type. Requires an implicit bijection used for transcoding.
Example: new Regex("""([a-z]+)""", "id") ~ List('id) In use example: ads / foo / new Regex("""([a-z]+)""", "id") ~ List('id)
Example: new Regex("""([a-z]+)""", "id") ~ List('id) In use example: ads / foo / new Regex("""([a-z]+)""", "id") ~ List('id)
A note about groups for scala Regex: Scala Regex is based off of Java Pattern, in which groups are not given names, only numbers based on the order in which they appear. Thus, the labels one gives groups in the Scala Regex are assigned based on ordering from the java Pattern. As such, in the following example, New Regex("""(a|z)(b+)""", "id1", "id2") id1 referss to the capture group a|z, whereas id2 refers to b+.
Yields the remaining path to the specified function, which should return a request handler.
Yields the remaining path to the specified function, which should return a request handler.
remainingPath { path =>
get {
...
}
}
Augments the service with request/response logging.
Augments the service with request/response logging.
requestLogging {
request { state =>
...
}
}
Augments the service with a locator, which is capable of creating HTTP clients that connect to other BlueEyes services based on settings in the config file.
Augments the service with a locator, which is capable of creating HTTP clients that connect to other BlueEyes services based on settings in the config file.
To locate foo/v1, the locator will look at the config setting: services.foo.v1.serviceRootUrl
serviceLocator { locator =>
...
val content = locator("email", "1.01") { client =>
client.get("").map{ response => response.content.get }
}
}
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
The xml combinator creates a handler that accepts and produces XML.
The xml combinator creates a handler that accepts and produces XML. Requires an implicit bijection used for transcoding.