t

com.twitter.finatra.http.marshalling

DefaultMessageBodyWriter

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

com.twitter.finatra.http.marshalling.MessageBodyManager

com.twitter.finatra.http.modules.MessageBodyModule

com.twitter.finatra.http.HttpServer.messageBodyModule

https://twitter.github.io/finatra/user-guide/json/routing.html#responses

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultMessageBodyWriter
  2. MessageBodyWriter
  3. MessageBodyComponent
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def write(obj: Any): WriterResponse
    Definition Classes
    MessageBodyWriter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. def write(message: Message, obj: Any): WriterResponse
    Definition Classes
    MessageBodyWriter

Inherited from MessageBodyWriter[Any]

Inherited from MessageBodyComponent

Inherited from AnyRef

Inherited from Any

Ungrouped