Class JaxrsClientFilter

  • All Implemented Interfaces:
    javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter

    @Provider
    public class JaxrsClientFilter
    extends java.lang.Object
    implements javax.ws.rs.client.ClientRequestFilter, javax.ws.rs.client.ClientResponseFilter
    JAX-RS client request and response filter to provide instrumentation of client calls with OpenCensus.
    Since:
    0.19
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private HttpClientHandler<javax.ws.rs.client.ClientRequestContext,​javax.ws.rs.client.ClientResponseContext,​javax.ws.rs.client.ClientRequestContext> handler  
      private static java.lang.String OPENCENSUS_CONTEXT  
      private static TextFormat.Setter<javax.ws.rs.client.ClientRequestContext> SETTER  
    • Constructor Summary

      Constructors 
      Constructor Description
      JaxrsClientFilter()
      Constructs new client filter with default configuration.
      JaxrsClientFilter​(HttpExtractor<javax.ws.rs.client.ClientRequestContext,​javax.ws.rs.client.ClientResponseContext> extractor, TextFormat propagationFormat)
      Construct new client filter with custom configuration.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void filter​(javax.ws.rs.client.ClientRequestContext requestContext)  
      void filter​(javax.ws.rs.client.ClientRequestContext requestContext, javax.ws.rs.client.ClientResponseContext responseContext)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • OPENCENSUS_CONTEXT

        private static final java.lang.String OPENCENSUS_CONTEXT
        See Also:
        Constant Field Values
      • SETTER

        private static final TextFormat.Setter<javax.ws.rs.client.ClientRequestContext> SETTER
      • handler

        private final HttpClientHandler<javax.ws.rs.client.ClientRequestContext,​javax.ws.rs.client.ClientResponseContext,​javax.ws.rs.client.ClientRequestContext> handler
    • Constructor Detail

      • JaxrsClientFilter

        public JaxrsClientFilter()
        Constructs new client filter with default configuration.
      • JaxrsClientFilter

        public JaxrsClientFilter​(HttpExtractor<javax.ws.rs.client.ClientRequestContext,​javax.ws.rs.client.ClientResponseContext> extractor,
                                 TextFormat propagationFormat)
        Construct new client filter with custom configuration.
        Parameters:
        extractor - the HttpExtractor used to extract information from the request/response.
        propagationFormat - the TextFormat used in HTTP propagation.
    • Method Detail

      • filter

        public void filter​(javax.ws.rs.client.ClientRequestContext requestContext)
        Specified by:
        filter in interface javax.ws.rs.client.ClientRequestFilter
      • filter

        public void filter​(javax.ws.rs.client.ClientRequestContext requestContext,
                           javax.ws.rs.client.ClientResponseContext responseContext)
        Specified by:
        filter in interface javax.ws.rs.client.ClientResponseFilter