EnrichedResponse

abstract def body(buffer: Buf): EnrichedResponse

Return a response with the given com.twitter.io.Buf set as the response body.

abstract def body(inputStream: InputStream): EnrichedResponse

Return a response with the given InputStream written as bytes as the response body.

abstract def body(bodyStr: String): EnrichedResponse

Return a response with the given String written as the response body.

abstract def body(b: Array[Byte]): EnrichedResponse

Return a response with the given Array[Byte] written as the response body.

abstract def body(request: Request, any: Any): EnrichedResponse

Return a response with a written body potentially based on values contained within the com.twitter.finagle.http.Request.

abstract def body(any: Any): EnrichedResponse

Return a response with the given object as the written response body.

abstract def contentType(mediaType: String): EnrichedResponse

Set the "Content-Type" response header field of this EnrichedResponse to the given String.

abstract def contentTypeJson(): EnrichedResponse

Set the "Content-Type" header field for this EnrichedResponse to "application/json".

abstract def cookie(c: Cookie): EnrichedResponse

Set the given com.twitter.finagle.http.Cookie on the returned Response.

abstract def cookie(name: String, value: String): EnrichedResponse

Set a com.twitter.finagle.http.Cookie with the given name and value on the returned Response.

abstract def failure(request: Request, exception: DetailedNonRetryableSourcedException): EnrichedResponse

Helper method for returning responses that are the result of a "service-level" failure.

abstract def failure(request: Request, source: String, details: Seq[Any], message: String = ""): EnrichedResponse

Helper method for returning responses that are the result of a "service-level" failure.

@Singleton
class AuthenticationExceptionMapper @Inject()(
 response: ResponseBuilder)
extends ExceptionMapper[AuthenticationException] {

 override def toResponse(
   request: Request,
   exception: AuthenticationException
 ): Response = {
   response
     .status(exception.status)
     .failureClassifier(
       is5xxStatus(exception.status),
       request,
       exception)
   .jsonError(s"Your account could not be authenticated. Reason: ${exception.resultCode}")
 }
}

abstract def failureClassifier(classifier: ⇒ Boolean, request: Request, source: String, details: Seq[Any] = Seq(), message: String = ""): EnrichedResponse

Helper method for returning responses that are the result of a "service-level" failure.

abstract def failureClassifier(classifier: ⇒ Boolean, request: Request, exception: DetailedNonRetryableSourcedException): EnrichedResponse

Helper method for returning responses that are the result of a "service-level" failure.

abstract def file(file: String): EnrichedResponse

Return a response resolving the given file path to a java.io.File using the configured com.twitter.finatra.utils.FileResolver.

abstract def file(file: File): EnrichedResponse

Return a response with the given java.io.File bytes as the response body.

abstract def fileOrIndex(filePath: String, indexPath: String): EnrichedResponse

Return the file (only if it's an existing file w/ an extension), otherwise return the index.

abstract def header(k: String, v: Any): EnrichedResponse

Return a response with the given response header key/value set.

abstract def headers(entries: (String, Any)*): EnrichedResponse

Return a response with the given response headers set.

abstract def headers(map: Map[String, String]): EnrichedResponse

Return a response with the given response headers set.

abstract def html(any: Any): EnrichedResponse

Return a response with the given object written as a HTML response body.

abstract def html(html: String): EnrichedResponse

Return a response with the given String written as a HTML response body.

abstract def json(obj: Any): EnrichedResponse

Return a JSON-formatted body from the given object.

abstract def jsonError(message: String): EnrichedResponse

Create a JSON-formatted ErrorsResponse response body based on the given string.

abstract def jsonError: EnrichedResponse

Create a JSON-formatted ErrorsResponse response body based on this response's current com.twitter.finagle.http.Status.

abstract def location(uri: String): EnrichedResponse

Return a response with the "Location" response header field set to the given URI value.

abstract def location(uri: Any): EnrichedResponse

Return a response with the "Location" response header field set to the given URI value.

abstract def plain(any: Any): EnrichedResponse

Return a response with the given object written as a plaintext response body.

abstract def response: Response

abstract def toException: HttpResponseException

Returns a HttpResponseException built from the Response wrapped by this EnrichedResponse

abstract def toFuture: Future[Response]

Returns this EnrichedResponse wrapped in a com.twitter.util.Future

abstract def toFutureException[T]: Future[T]

Returns a failed Future of type [T] containing the result of EnrichedResponse#toException.

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def accept: Seq[String]

def acceptMediaTypes: Seq[String]

def accept_=(values: Iterable[String]): Unit

def accept_=(value: String): Unit

def addCookie(cookie: Cookie): Unit

def allow: Option[String]

def allow_=(values: Iterable[Method]): Unit

def allow_=(value: String): Unit

final def asInstanceOf[T0]: T0

def authorization: Option[String]

def authorization_=(value: String): Unit

def cacheControl: Option[String]

def cacheControl_=(maxAge: Duration): Unit

def cacheControl_=(value: String): Unit

def charset: Option[String]

def charset_=(value: String): Unit

def chunkReader: Reader[Chunk]

def chunkWriter: Writer[Chunk]

final def clearContent(): Unit

def clone(): AnyRef

def close(): Future[Unit]

final def content: Buf

final def content(content: Buf): EnrichedResponse.this.type

final def contentLength(value: Long): EnrichedResponse.this.type

def contentLength: Option[Long]

final def contentLengthOrElse(default: Long): Long

def contentLength_=(value: Long): Unit

def contentString: String

def contentString_=(value: String): Unit

def contentType: Option[String]

def contentType_=(value: String): Unit

final def content_=(content: Buf): Unit

lazy val cookies: CookieMap

def ctx: Record

def date: Option[String]

def date_=(value: Date): Unit

def date_=(value: String): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def expires: Option[String]

def expires_=(value: Date): Unit

def expires_=(value: String): Unit

def finalize(): Unit

final def getClass(): Class[_]

def getContentString(): String

def getCookies(): Iterator[Cookie]

final def getInputStream(): InputStream

final def getLength(): Int

final def getReader(): Reader

def hashCode(): Int

def headerMap: HeaderMap

final def host(value: String): EnrichedResponse.this.type

def host: Option[String]

def host_=(value: String): Unit

final def isChunked: Boolean

final def isInstanceOf[T0]: Boolean

final def isRequest: Boolean

def isResponse: Boolean

def isXmlHttpRequest: Boolean

final def keepAlive: Boolean

final def keepAlive(keepAlive: Boolean): EnrichedResponse.this.type

def lastModified: Option[String]

def lastModified_=(value: Date): Unit

def lastModified_=(value: String): Unit

final def length: Int

def location: Option[String]

def location_=(value: String): Unit

def mediaType: Option[String]

def mediaType_=(value: String): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final lazy val reader: Reader[Buf]

def referer: Option[String]

def referer_=(value: String): Unit

def removeCookie(name: String): Unit

def retryAfter: Option[String]

def retryAfter_=(value: Long): Unit

def retryAfter_=(value: String): Unit

def server: Option[String]

def server_=(value: String): Unit

final def setChunked(chunked: Boolean): Unit

final def setContentString(value: String): Unit

def setContentType(mediaType: String, charset: String): Unit

def setContentTypeJson(): Unit

final def status: Status

final def status(value: Status): EnrichedResponse.this.type

final def statusCode(value: Int): EnrichedResponse.this.type

final def statusCode: Int

final def statusCode_=(value: Int): Unit

final def status_=(value: Status): Unit

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

def toString(): String

def trailers: HeaderMap

def userAgent: Option[String]

def userAgent_=(value: String): Unit

final def version: Version

final def version(version: Version): EnrichedResponse.this.type

final def version_=(version: Version): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withInputStream[T](f: (InputStream) ⇒ T): T

final def withOutputStream[T](f: (OutputStream) ⇒ T): T

final def withReader[T](f: (Reader) ⇒ T): T

final def withWriter[T](f: (Writer) ⇒ T): T

final def write(bytes: Array[Byte]): Unit

final def write(buf: Buf): Unit

final def write(string: String): Unit

final lazy val writer: Writer[Buf]

def wwwAuthenticate: Option[String]

def wwwAuthenticate_=(value: String): Unit

def xForwardedFor: Option[String]

def xForwardedFor_=(value: String): Unit