Class DefaultClientHeadersFactoryImpl

  • All Implemented Interfaces:

    public class DefaultClientHeadersFactoryImpl
    extends java.lang.Object
    implements ClientHeadersFactory
    This class propagates JAX-RS headers whose names are specified using the MicroProfile Config property,

    The value of this property should be a comma-separated list of HTTP header names. If the headers specified in the property exist in the inbound JAX-RS request, this class will propagate those headers to the outbound Rest Client request.

    • Field Summary

      Modifier and Type Field Description
      static java.lang.String PROPAGATE_PROPERTY  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description<java.lang.String,java.lang.String> update​(<java.lang.String,java.lang.String> incomingHeaders,<java.lang.String,java.lang.String> clientOutgoingHeaders)
      Updates the HTTP headers to send to the remote service.
      • Methods inherited from class java.lang.Object

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


        public static final java.lang.String PROPAGATE_PROPERTY
        See Also:
        Constant Field Values
    • Constructor Detail

      • DefaultClientHeadersFactoryImpl

        public DefaultClientHeadersFactoryImpl​()
    • Method Detail

      • update

        public<java.lang.String,java.lang.String> update​(<java.lang.String,java.lang.String> incomingHeaders,
                                                                               <java.lang.String,java.lang.String> clientOutgoingHeaders)
        Description copied from interface: ClientHeadersFactory
        Updates the HTTP headers to send to the remote service. Note that providers on the outbound processing chain could further update the headers.
        Specified by:
        update in interface ClientHeadersFactory
        incomingHeaders - - the map of headers from the inbound JAX-RS request. This will be an empty map if the associated client interface is not part of a JAX-RS request.
        clientOutgoingHeaders - - the read-only map of header parameters specified on the client interface.
        a map of HTTP headers to merge with the clientOutgoingHeaders to be sent to the remote service.