Trait

com.twitter.finatra.http.marshalling

DefaultMessageBodyWriter

Related Doc: package marshalling

Permalink

trait DefaultMessageBodyWriter extends MessageBodyWriter[Any]

A marker trait denoting the default MessageBodyWriter for the HTTP server. This default MessageBodyWriter is invoked by either the com.twitter.finatra.http.internal.marshalling.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 MessageBodyWriter will attempt to convert the outgoing type T to a JSON response using the server's configured com.twitter.finatra.json.FinatraObjectMapper.

See also

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

com.twitter.finatra.http.HttpServer.messageBodyModule

com.twitter.finatra.http.modules.MessageBodyModule

com.twitter.finatra.http.internal.marshalling.MessageBodyManager

com.twitter.finatra.http.internal.marshalling.DefaultMessageBodyWriterImpl

Linear Supertypes
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. All

Abstract Value Members

  1. abstract def write(obj: Any): WriterResponse

    Permalink
    Definition Classes
    MessageBodyWriter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def write(request: Request, obj: Any): WriterResponse

    Permalink
    Definition Classes
    MessageBodyWriter

Inherited from MessageBodyWriter[Any]

Inherited from MessageBodyComponent

Inherited from AnyRef

Inherited from Any

Ungrouped