Packages

c

com.twitter.finatra.http.filters

HttpResponseFilter

class HttpResponseFilter[R <: Request] extends SimpleFilter[R, Response]

HttpResponseFilter does the following:

  • Sets the 'Server' and 'Date' response header values.
  • Optionally turns a relative 'Location' header value into a full URL. See fullyQualifyLocationHeader.

By default this filter allows for returning relative references as 'Location' header values. In order to always attempt to fully specify a relative reference, this class should be instantiated with the constructor arg fullyQualifyLocationHeader set to 'true'.

Annotations
@Singleton()
Note

This filter does NOT throw exceptions when it is unable to set a location header value because of non RFC 7230 compliant values. Generally this filter is installed "above" the ExceptionMappingFilter and therefore translation of an exception into an appropriate HTTP response is not available thus the filter logs a warning message. This means that if there is a non-compliant 'Location' header value in the outgoing Response this filter will not fully qualify, nor replace, nor remove it.

See also

HTTP location

Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content

Relative Reference

Linear Supertypes
SimpleFilter[R, Response], Filter[R, Response, R, Response], (R, Service[R, Response]) => Future[Response], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpResponseFilter
  2. SimpleFilter
  3. Filter
  4. Function2
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HttpResponseFilter()
  2. new HttpResponseFilter(fullyQualifyLocationHeader: Boolean)

    fullyQualifyLocationHeader

    the Filter should attempt to always fully qualify the value of the response 'Location' header. Default: false

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. def agnosticAndThen(next: TypeAgnostic): Filter[R, Response, R, Response]
    Definition Classes
    Filter
  5. def andThen(factory: ServiceFactory[R, Response]): ServiceFactory[R, Response]
    Definition Classes
    Filter
  6. def andThen(service: Service[R, Response]): Service[R, Response]
    Definition Classes
    Filter
  7. def andThen[Req2, Rep2](next: Filter[R, Response, Req2, Rep2]): Filter[R, Response, Req2, Rep2]
    Definition Classes
    Filter
  8. def andThenIf[Req2 >: R, Rep2 <: Response](condAndFilter: (Boolean, Filter[R, Response, Req2, Rep2])): Filter[R, Response, Req2, Rep2]
    Definition Classes
    Filter
  9. def andThenIf[Req2 >: R, Rep2 <: Response](conditional: Boolean, filter: Filter[R, Response, Req2, Rep2]): Filter[R, Response, Req2, Rep2]
    Definition Classes
    Filter
  10. def apply(request: R, service: Service[R, Response]): Future[Response]
    Definition Classes
    HttpResponseFilter → Filter → Function2
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def curried: (R) => (Service[R, Response]) => Future[Response]
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def setLocationHeader(headerMap: HeaderMap, value: String): Unit

    Allows extensions to set a different function for setting the Response Location Header value, e.g., setUnsafe (which performs no validation) instead of the default set (which performs validation).

    Allows extensions to set a different function for setting the Response Location Header value, e.g., setUnsafe (which performs no validation) instead of the default set (which performs validation).

    headerMap

    the com.twitter.finagle.http.HeaderMap on which to set the Location header

    value

    the Location header value to set.

    returns

    the set function to use for setting the value.

    Attributes
    protected
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    Filter → Function2 → AnyRef → Any
  26. def tupled: ((R, Service[R, Response])) => Future[Response]
    Definition Classes
    Function2
    Annotations
    @unspecialized()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from SimpleFilter[R, Response]

Inherited from Filter[R, Response, R, Response]

Inherited from (R, Service[R, Response]) => Future[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped