trait DefaultMessageBodyWriter extends MessageBodyWriter[Any]
A marker trait denoting a class that can act as a default com.twitter.finatra.http.marshalling.MessageBodyWriter for the HTTP server.
This default is invoked by either the com.twitter.finatra.http.internal.CallbackConverter
(by invoking the com.twitter.finatra.http.response.ResponseBuilder) or
com.twitter.finatra.http.response.ResponseBuilder#write directly to return a suitable
response for a given return type.
The framework binds com.twitter.finatra.http.internal.marshalling.DefaultMessageBodyWriterImpl as an overridable implementation via the com.twitter.finatra.http.modules.MessageBodyModule. To override this implementation, provide a customized com.twitter.inject.TwitterModule by overriding com.twitter.finatra.http.HttpServer.messageBodyModule, e.g.,
class MyServer extends HttpServer { ... override val messageBodyModule = MyCustomMessageBodyModule }
The framework default will attempt to convert the outgoing type T
to a JSON response using the
server's configured com.twitter.util.jackson.ScalaObjectMapper.
The com.twitter.finatra.http.marshalling.DefaultMessageBodyWriter trait differs from the
com.twitter.finatra.http.marshalling.MessageBodyWriter trait in that the
default is not parameterized to a specific type but instead defines a generic write[T]
function
which can generate a response from a given type T
.
- Note
this class is an extension of the com.twitter.finatra.http.marshalling.MessageBodyWriter trait parameterized to the
Any
type.- See also
com.twitter.finatra.http.internal.marshalling.DefaultMessageBodyWriterImpl
https://twitter.github.io/finatra/user-guide/json/routing.html#responses
- Alphabetic
- By Inheritance
- DefaultMessageBodyWriter
- MessageBodyWriter
- MessageBodyComponent
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def write(obj: Any): WriterResponse
- Definition Classes
- MessageBodyWriter
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(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def write(message: Message, obj: Any): WriterResponse
- Definition Classes
- MessageBodyWriter