ResponseBuilder

Instance Constructors

new ResponseBuilder(objectMapper: ScalaObjectMapper, fileResolver: FileResolver, messageBodyManager: MessageBodyManager, statsReceiver: StatsReceiver, includeContentTypeCharset: Boolean)

Annotations
@Inject()

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
def accepted(body: Any): EnrichedResponse

Returns an HTTP 201 Created response with a written body.
Returns an HTTP 201 Created response with a written body.
body
the response body, or the information needed to render the body
def accepted: EnrichedResponse

Returns an HTTP 201 Created response.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def badGateway: EnrichedResponse

Returns an HTTP 502 Bad Gateway response.
def badRequest(body: Any): EnrichedResponse

Returns an HTTP 400 Bad Request response with a written body.
Returns an HTTP 400 Bad Request response with a written body.
body
the response body, or the information needed to render the body
def badRequest: EnrichedResponse

Returns an HTTP 400 Bad Request response.
def clientClosed: EnrichedResponse

Returns an HTTP 499 Client Closed response
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def conflict(body: Any): EnrichedResponse

Returns an HTTP 409 Conflict response with a written body.
Returns an HTTP 409 Conflict response with a written body.
body
the response body, or the information needed to render the body
def conflict: EnrichedResponse

Returns an HTTP 409 Conflict response.
def create(response: Response): EnrichedResponse

Generic method to wrap a com.twitter.finagle.http.Response with this builder for augmenting the response.
Generic method to wrap a com.twitter.finagle.http.Response with this builder for augmenting the response.
response
the com.twitter.finagle.http.Response to wrap.
def created(body: Any): EnrichedResponse

Returns an HTTP 201 Created response with a written body.
Returns an HTTP 201 Created response with a written body.
body
the response body, or the information needed to render the body
def created: EnrichedResponse

Returns an HTTP 201 Created response.
def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

Attributes
protected
Definition Classes
Logging
def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forbidden(body: Any): EnrichedResponse

Returns an HTTP 403 Forbidden response with a written body.
Returns an HTTP 403 Forbidden response with a written body.
body
the response body, or the information needed to render the body
def forbidden: EnrichedResponse

Returns an HTTP 403 Forbidden response
def found: EnrichedResponse

Returns an HTTP 302 Found response.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def gone(body: Any): EnrichedResponse

Returns an HTTP 410 Gone response with a written body.
Returns an HTTP 410 Gone response with a written body.
body
the response body, or the information needed to render the body
def gone: EnrichedResponse

Returns an HTTP 410 Gone response
def hashCode(): Int

Definition Classes
AnyRef → Any
val htmlContentType: String

Representation of the text/html content type governed by the includeContentTypeCharset Boolean which determines if the UTF-8 charset encoding parameter should be included in the content type.
Representation of the text/html content type governed by the includeContentTypeCharset Boolean which determines if the UTF-8 charset encoding parameter should be included in the content type.

See also
MessageBodyFlags
com.twitter.finagle.http.MediaType.HtmlUtf8
com.twitter.finagle.http.MediaType.Html
def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def internalServerError(body: Any): EnrichedResponse

Returns an HTTP 500 Internal Server Error response with a written body.
Returns an HTTP 500 Internal Server Error response with a written body.
body
the response body, or the information needed to render the body
def internalServerError: EnrichedResponse

Returns an HTTP 500 Internal Server Error response
def isDebugEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTraceEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
val jsonContentType: String

Representation of the application/json content type governed by the includeContentTypeCharset Boolean which determines if the UTF-8 charset encoding parameter should be included in the content type.
Representation of the application/json content type governed by the includeContentTypeCharset Boolean which determines if the UTF-8 charset encoding parameter should be included in the content type.

See also
MessageBodyFlags
com.twitter.finagle.http.MediaType.JsonUtf8
com.twitter.finagle.http.MediaType.Json
final def logger: Logger

Attributes
protected[this]
Definition Classes
Logging
final def loggerName: String

Attributes
protected[this]
Definition Classes
Logging
def methodNotAllowed: EnrichedResponse

Returns an HTTP 405 Method Not Allowed response.
def movedPermanently(body: Any): EnrichedResponse

Returns an HTTP 301 Moved Permanently response with a written body
Returns an HTTP 301 Moved Permanently response with a written body
body
the response body, or the information needed to render the body
def movedPermanently: EnrichedResponse

Returns an HTTP 301 Moved Permanently response.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def noContent: EnrichedResponse

Returns an HTTP 204 No Content response.
def notAcceptable(body: Any): EnrichedResponse

Returns an HTTP 406 Not Acceptable response with a written body.
Returns an HTTP 406 Not Acceptable response with a written body.
body
the response body, or the information needed to render the body
def notAcceptable: EnrichedResponse

Returns an HTTP 406 Not Acceptable response.
def notFound(body: String): EnrichedResponse

Returns an HTTP 404 Not Found response with a written String body.
Returns an HTTP 404 Not Found response with a written String body.
body
the response body as a String
def notFound(body: Any): EnrichedResponse

Returns an HTTP 404 Not Found response with a written body.
Returns an HTTP 404 Not Found response with a written body.
body
the response body, or the information needed to render the body
def notFound: EnrichedResponse

Returns an HTTP 404 Not Found response
def notImplemented: EnrichedResponse

Returns an HTTP 501 Not Implemented response
def notModified: EnrichedResponse

Returns an HTTP 304 Not Modified response.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def ok(body: String): EnrichedResponse

Returns an HTTP 200 OK response with a written String body.
Returns an HTTP 200 OK response with a written String body.
body
the response body as a String
def ok(request: Request, body: Any): EnrichedResponse

Returns an HTTP 200 OK response with a written body, potentially based on values contained within the com.twitter.finagle.http.Request.
Returns an HTTP 200 OK response with a written body, potentially based on values contained within the com.twitter.finagle.http.Request.
request
the HTTP com.twitter.finagle.http.Request associated with this response
body
the response body, or the information needed to render the body

Note
This version is useful when the body parameter requires custom message body rendering and values in the Request are required for decision making.
def ok(body: Any): EnrichedResponse

Returns an HTTP 200 OK response with a written body.
Returns an HTTP 200 OK response with a written body.
body
the response body, or the information needed to render the body
def ok: EnrichedResponse

Returns an HTTP 200 OK response.
val plainTextContentType: String

Representation of the text/plain content type governed by the includeContentTypeCharset Boolean which determines if the UTF-8 charset encoding parameter should be included in the content type.
Representation of the text/plain content type governed by the includeContentTypeCharset Boolean which determines if the UTF-8 charset encoding parameter should be included in the content type.

See also
MessageBodyFlags
com.twitter.finagle.http.MediaType.PlainTextUtf8
com.twitter.finagle.http.MediaType.PlainText
def preconditionFailed(body: Any): EnrichedResponse

Returns an HTTP 412 Precondition Failed response with a written body.
Returns an HTTP 412 Precondition Failed response with a written body.
body
the response body, or the information needed to render the body
def preconditionFailed: EnrichedResponse

Returns an HTTP 412 Precondition Failed response
def requestEntityTooLarge(body: Any): EnrichedResponse

Returns an HTTP 413 Request Entity Too Large response with a written body.
Returns an HTTP 413 Request Entity Too Large response with a written body.
body
the response body, or the information needed to render the body
def requestEntityTooLarge: EnrichedResponse

Returns an HTTP 413 Request Entity Too Large response
def serviceUnavailable: EnrichedResponse

Returns an HTTP 503 Service Unavailable response
def status(responseStatus: Status): EnrichedResponse

Returns a response with the given com.twitter.finagle.http.Status
Returns a response with the given com.twitter.finagle.http.Status
responseStatus
the com.twitter.finagle.http.Status to set in the returned response
def status(statusCode: Int): EnrichedResponse

Returns a response with the given status code.
Returns a response with the given status code.
statusCode
the HTTP status code to set in the returned response
def streaming[F[_], A](stream: F[A])(implicit arg0: ToReader[F], arg1: Manifest[A]): streaming.StreamingResponse[F, A]

Java support for streaming
def streaming[F[_], A](stream: F[A], status: Status = Status.Ok, headers: Map[String, Seq[String]] = Map.empty)(implicit arg0: ToReader[F], arg1: Manifest[A]): streaming.StreamingResponse[F, A]

Create a StreamingResponse which can be converted to a com.twitter.finagle.http.Response later.
Create a StreamingResponse which can be converted to a com.twitter.finagle.http.Response later.
F
The Primitive Stream type.
A
The type of streaming values.
stream
The output stream.
status
Represents an HTTP status code.
headers
A Map of message headers.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def temporaryRedirect: EnrichedResponse

Returns an HTTP 307 Temporary Redirect response.
def time[T](formatStr: String)(func: ⇒ T): T

Attributes
protected
Definition Classes
Logging
def toString(): String

Definition Classes
AnyRef → Any
def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def traceResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def unauthorized(body: Any): EnrichedResponse

Returns an HTTP 401 Unauthorized response with a written body.
Returns an HTTP 401 Unauthorized response with a written body.
body
the response body, or the information needed to render the body
def unauthorized: EnrichedResponse

Returns an HTTP 401 Unauthorized response.
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( ... )
def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def warnResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging

Related Docs: object ResponseBuilder | package response

class ResponseBuilder extends Logging

Instance Constructors

new ResponseBuilder(objectMapper: ScalaObjectMapper, fileResolver: FileResolver, messageBodyManager: MessageBodyManager, statsReceiver: StatsReceiver, includeContentTypeCharset: Boolean)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def accepted(body: Any): EnrichedResponse

def accepted: EnrichedResponse

final def asInstanceOf[T0]: T0

def badGateway: EnrichedResponse

def badRequest(body: Any): EnrichedResponse

def badRequest: EnrichedResponse

def clientClosed: EnrichedResponse

def clone(): AnyRef

def conflict(body: Any): EnrichedResponse

def conflict: EnrichedResponse

def create(response: Response): EnrichedResponse

def created(body: Any): EnrichedResponse

def created: EnrichedResponse

def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def debug(message: ⇒ Any, cause: Throwable): Unit

def debug(marker: Marker, message: ⇒ Any): Unit

def debug(message: ⇒ Any): Unit

def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def error(message: ⇒ Any, cause: Throwable): Unit

def error(marker: Marker, message: ⇒ Any): Unit

def error(message: ⇒ Any): Unit

def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

def finalize(): Unit

def forbidden(body: Any): EnrichedResponse

def forbidden: EnrichedResponse

def found: EnrichedResponse

final def getClass(): Class[_]

def gone(body: Any): EnrichedResponse

def gone: EnrichedResponse

def hashCode(): Int

val htmlContentType: String

def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def info(message: ⇒ Any, cause: Throwable): Unit

def info(marker: Marker, message: ⇒ Any): Unit

def info(message: ⇒ Any): Unit

def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

def internalServerError(body: Any): EnrichedResponse

def internalServerError: EnrichedResponse

def isDebugEnabled(marker: Marker): Boolean

def isDebugEnabled: Boolean

def isErrorEnabled(marker: Marker): Boolean

def isErrorEnabled: Boolean

def isInfoEnabled(marker: Marker): Boolean

def isInfoEnabled: Boolean

final def isInstanceOf[T0]: Boolean

def isTraceEnabled(marker: Marker): Boolean

def isTraceEnabled: Boolean

def isWarnEnabled(marker: Marker): Boolean

def isWarnEnabled: Boolean

val jsonContentType: String

final def logger: Logger

final def loggerName: String

def methodNotAllowed: EnrichedResponse

def movedPermanently(body: Any): EnrichedResponse

def movedPermanently: EnrichedResponse

final def ne(arg0: AnyRef): Boolean

def noContent: EnrichedResponse

def notAcceptable(body: Any): EnrichedResponse

def notAcceptable: EnrichedResponse

def notFound(body: String): EnrichedResponse

def notFound(body: Any): EnrichedResponse

def notFound: EnrichedResponse

def notImplemented: EnrichedResponse

def notModified: EnrichedResponse

final def notify(): Unit

final def notifyAll(): Unit

def ok(body: String): EnrichedResponse