| {"component":{"kind":"component","name":"https","title":"HTTPS (Secure)","description":"Send requests to external HTTP servers using Apache HTTP Client 4.x.","deprecated":false,"deprecationNote":"","firstVersion":"2.3.0","label":"http","javaType":"org.apache.camel.component.http.HttpComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-http","version":"3.18.1","scheme":"https","extendsScheme":"","alternativeSchemes":"http,https","syntax":"https://httpUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":true,"verifiers":"parameters,connectivity"},"headers":{"Content-Encoding":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_ENCODING"},"CamelHttpResponseCode":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response code from the external server. Is 200 for OK.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_CODE"},"CamelHttpResponseText":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP response text from the external server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RESPONSE_TEXT"},"CamelHttpQuery":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI parameters. Will override existing URI parameters set directly on the endpoint.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_QUERY"},"CamelHttpProtocolVersion":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The version of the http protocol used.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PROTOCOL_VERSION"},"Host":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The target host.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_HEADER_HOST"},"CamelRestHttpUri":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http URI.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_URI"},"CamelHttpUri":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URI to call. Will override existing URI set directly on the endpoint. This uri is the uri of the http server to call. Its not the same as the Camel endpoint uri, where you can configure endpoint options such as security etc. This header does not support that, its only the uri of the http server.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_URI"},"CamelHttpPath":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Request URI's path, the header will be used to build the request URI with the HTTP_URI.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_PATH"},"CamelRestHttpQuery":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The rest http query.","constantName":"org.apache.camel.component.http.HttpConstants#REST_HTTP_QUERY"},"CamelHttpRawQuery":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http raw query.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_RAW_QUERY"},"CamelHttpMethod":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.http.HttpMethods","enum":["GET","PATCH","POST","PUT","DELETE","HEAD","OPTIONS","TRACE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The http method to use.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_METHOD"},"CamelHttpCharacterEncoding":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character encoding.","constantName":"org.apache.camel.component.http.HttpConstants#HTTP_CHARACTER_ENCODING"},"Content-Type":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.","constantName":"org.apache.camel.component.http.HttpConstants#CONTENT_TYPE"}},"properties":{"httpUri":{"kind":"path","displayName":"Http Uri","group":"common","label":"common","required":true,"type":"string","javaType":"java.net.URI","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The url of the HTTP endpoint to call."},"disableStreamCache":{"kind":"parameter","displayName":"Disable Stream Cache","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body."},"headerFilterStrategy":{"kind":"parameter","displayName":"Header Filter Strategy","group":"common","label":"common","required":false,"type":"object","javaType":"org.apache.camel.spi.HeaderFilterStrategy","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HeaderFilterStrategy to filter header to and from Camel message."},"bridgeEndpoint":{"kind":"parameter","displayName":"Bridge Endpoint","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."},"clearExpiredCookies":{"kind":"parameter","displayName":"Clear Expired Cookies","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. If the component has disabled cookie management then this option is disabled too."},"connectionClose":{"kind":"parameter","displayName":"Connection Close","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."},"copyHeaders":{"kind":"parameter","displayName":"Copy Headers","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."},"customHostHeader":{"kind":"parameter","displayName":"Custom Host Header","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url."},"httpMethod":{"kind":"parameter","displayName":"Http Method","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.http.common.HttpMethods","enum":["GET","POST","PUT","DELETE","HEAD","OPTIONS","TRACE","PATCH"],"deprecated":false,"autowired":false,"secret":false,"description":"Configure the HTTP method to use. The HttpMethod header cannot override this option if set."},"ignoreResponseBody":{"kind":"parameter","displayName":"Ignore Response Body","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, The http producer won't read response body and cache the input stream"},"preserveHostHeader":{"kind":"parameter","displayName":"Preserve Host Header","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"},"throwExceptionOnFailure":{"kind":"parameter","displayName":"Throw Exception On Failure","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."},"cookieHandler":{"kind":"parameter","displayName":"Cookie Handler","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.camel.http.base.cookie.CookieHandler","deprecated":false,"autowired":false,"secret":false,"description":"Configure a cookie handler to maintain a HTTP session"},"cookieStore":{"kind":"parameter","displayName":"Cookie Store","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"object","javaType":"org.apache.http.client.CookieStore","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."},"deleteWithBody":{"kind":"parameter","displayName":"Delete With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"getWithBody":{"kind":"parameter","displayName":"Get With Body","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"okStatusCodeRange":{"kind":"parameter","displayName":"Ok Status Code Range","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"200-299","description":"The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."},"skipRequestHeaders":{"kind":"parameter","displayName":"Skip Request Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"skipResponseHeaders":{"kind":"parameter","displayName":"Skip Response Headers","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector."},"userAgent":{"kind":"parameter","displayName":"User Agent","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"To set a custom HTTP User-Agent request header"},"clientBuilder":{"kind":"parameter","displayName":"Client Builder","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.impl.client.HttpClientBuilder","deprecated":false,"autowired":false,"secret":false,"description":"Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."},"clientConnectionManager":{"kind":"parameter","displayName":"Client Connection Manager","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.conn.HttpClientConnectionManager","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpClientConnectionManager to manage connections"},"connectionsPerRoute":{"kind":"parameter","displayName":"Connections Per Route","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":20,"description":"The maximum number of connections per route."},"httpClient":{"kind":"parameter","displayName":"Http Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.client.HttpClient","deprecated":false,"autowired":false,"secret":false,"description":"Sets a custom HttpClient to be used by the producer"},"httpClientConfigurer":{"kind":"parameter","displayName":"Http Client Configurer","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.http.HttpClientConfigurer","deprecated":false,"autowired":false,"secret":false,"description":"Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc."},"httpClientOptions":{"kind":"parameter","displayName":"Http Client Options","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","prefix":"httpClient.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure the HttpClient using the key/values from the Map."},"httpContext":{"kind":"parameter","displayName":"Http Context","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.http.protocol.HttpContext","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom HttpContext instance"},"maxTotalConnections":{"kind":"parameter","displayName":"Max Total Connections","group":"advanced","label":"advanced","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":200,"description":"The maximum number of connections."},"useSystemProperties":{"kind":"parameter","displayName":"Use System Properties","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"To use System Properties as fallback for configuration"},"proxyAuthDomain":{"kind":"parameter","displayName":"Proxy Auth Domain","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain to use with NTML"},"proxyAuthHost":{"kind":"parameter","displayName":"Proxy Auth Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication host"},"proxyAuthMethod":{"kind":"parameter","displayName":"Proxy Auth Method","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication method to use"},"proxyAuthNtHost":{"kind":"parameter","displayName":"Proxy Auth Nt Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication domain (workstation name) to use with NTML"},"proxyAuthPassword":{"kind":"parameter","displayName":"Proxy Auth Password","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyAuthPort":{"kind":"parameter","displayName":"Proxy Auth Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication port"},"proxyAuthScheme":{"kind":"parameter","displayName":"Proxy Auth Scheme","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"autowired":false,"secret":false,"description":"Proxy authentication scheme to use"},"proxyAuthUsername":{"kind":"parameter","displayName":"Proxy Auth Username","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Proxy authentication username"},"proxyHost":{"kind":"parameter","displayName":"Proxy Host","group":"proxy","label":"producer,proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Proxy hostname to use"},"proxyPort":{"kind":"parameter","displayName":"Proxy Port","group":"proxy","label":"producer,proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"Proxy port to use"},"authDomain":{"kind":"parameter","displayName":"Auth Domain","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication domain to use with NTML"},"authenticationPreemptive":{"kind":"parameter","displayName":"Authentication Preemptive","group":"security","label":"producer,security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If this option is true, camel-http sends preemptive basic authentication to the server."},"authHost":{"kind":"parameter","displayName":"Auth Host","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication host to use with NTML"},"authMethod":{"kind":"parameter","displayName":"Auth Method","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."},"authMethodPriority":{"kind":"parameter","displayName":"Auth Method Priority","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","enum":["Basic","Digest","NTLM"],"deprecated":false,"autowired":false,"secret":false,"description":"Which authentication method to prioritize to use, either as Basic, Digest or NTLM."},"authPassword":{"kind":"parameter","displayName":"Auth Password","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication password"},"authUsername":{"kind":"parameter","displayName":"Auth Username","group":"security","label":"producer,security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Authentication username"},"sslContextParameters":{"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"description":"To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."},"x509HostnameVerifier":{"kind":"parameter","displayName":"X509 Hostname Verifier","group":"security","label":"security","required":false,"type":"object","javaType":"javax.net.ssl.HostnameVerifier","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier"}}} |