diff --git a/component.json b/component.json new file mode 100644 index 0000000..ab06aca --- /dev/null +++ b/component.json @@ -0,0 +1,388 @@ +{ + "component": { + "kind": "component", + "name": "platform-http", + "title": "Platform HTTP", + "description": "Expose HTTP endpoints using the HTTP server available in the current platform.", + "deprecated": false, + "firstVersion": "3.0.0", + "label": "http", + "javaType": "org.apache.camel.component.platform.http.PlatformHttpComponent", + "supportLevel": "Stable", + "metadata": { + "protocol": "http" + }, + "groupId": "org.apache.camel", + "artifactId": "camel-platform-http", + "version": "4.10.2", + "scheme": "platform-http", + "extendsScheme": "", + "syntax": "platform-http:path", + "async": true, + "api": false, + "consumerOnly": true, + "producerOnly": false, + "lenientProperties": false, + "browsable": false, + "remote": true + }, + "properties": { + "path": { + "index": 0, + "kind": "path", + "displayName": "Path", + "group": "consumer", + "label": "", + "required": true, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "deprecationNote": "", + "autowired": false, + "secret": false, + "description": "The path under which this endpoint serves the HTTP requests, for proxy use 'proxy'" + }, + "consumes": { + "index": 1, + "kind": "parameter", + "displayName": "Consumes", + "group": "consumer", + "label": "consumer", + "required": false, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "The content type this endpoint accepts as an input, such as application/xml or application/json. null or */* mean no restriction." + }, + "cookieDomain": { + "index": 2, + "kind": "parameter", + "displayName": "Cookie Domain", + "group": "consumer", + "label": "", + "required": false, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "autowired": false, + "secret": false, + "configurationClass": "org.apache.camel.component.platform.http.cookie.CookieConfiguration", + "configurationField": "cookieConfiguration", + "description": "Sets which server can receive cookies." + }, + "cookieHttpOnly": { + "index": 3, + "kind": "parameter", + "displayName": "Cookie Http Only", + "group": "consumer", + "label": "", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "configurationClass": "org.apache.camel.component.platform.http.cookie.CookieConfiguration", + "configurationField": "cookieConfiguration", + "description": "Sets whether to prevent client side scripts from accessing created cookies." + }, + "cookieMaxAge": { + "index": 4, + "kind": "parameter", + "displayName": "Cookie Max Age", + "group": "consumer", + "label": "", + "required": false, + "type": "integer", + "javaType": "java.lang.Long", + "deprecated": false, + "autowired": false, + "secret": false, + "configurationClass": "org.apache.camel.component.platform.http.cookie.CookieConfiguration", + "configurationField": "cookieConfiguration", + "description": "Sets the maximum cookie age in seconds." + }, + "cookiePath": { + "index": 5, + "kind": "parameter", + "displayName": "Cookie Path", + "group": "consumer", + "label": "", + "required": false, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": "/", + "configurationClass": "org.apache.camel.component.platform.http.cookie.CookieConfiguration", + "configurationField": "cookieConfiguration", + "description": "Sets the URL path that must exist in the requested URL in order to send the Cookie." + }, + "cookieSameSite": { + "index": 6, + "kind": "parameter", + "displayName": "Cookie Same Site", + "group": "consumer", + "label": "", + "required": false, + "type": "object", + "javaType": "org.apache.camel.component.platform.http.cookie.CookieConfiguration.CookieSameSite", + "enum": [ + "STRICT", + "LAX", + "NONE" + ], + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": "Lax", + "configurationClass": "org.apache.camel.component.platform.http.cookie.CookieConfiguration", + "configurationField": "cookieConfiguration", + "description": "Sets whether to prevent the browser from sending cookies along with cross-site requests." + }, + "cookieSecure": { + "index": 7, + "kind": "parameter", + "displayName": "Cookie Secure", + "group": "consumer", + "label": "", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "configurationClass": "org.apache.camel.component.platform.http.cookie.CookieConfiguration", + "configurationField": "cookieConfiguration", + "description": "Sets whether the cookie is only sent to the server with an encrypted request over HTTPS." + }, + "handleWriteResponseError": { + "index": 8, + "kind": "parameter", + "displayName": "Handle Write Response Error", + "group": "consumer", + "label": "advanced,consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "description": "When Camel is complete processing the message, and the HTTP server is writing response. This option controls whether Camel should catch any failure during writing response and store this on the Exchange, which allows onCompletion/UnitOfWork to regard the Exchange as failed and have access to the caused exception from the HTTP server." + }, + "httpMethodRestrict": { + "index": 9, + "kind": "parameter", + "displayName": "Http Method Restrict", + "group": "consumer", + "label": "consumer", + "required": false, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "A comma separated list of HTTP methods to serve, e.g. GET,POST . If no methods are specified, all methods will be served." + }, + "matchOnUriPrefix": { + "index": 10, + "kind": "parameter", + "displayName": "Match On Uri Prefix", + "group": "consumer", + "label": "consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "description": "Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found." + }, + "muteException": { + "index": 11, + "kind": "parameter", + "displayName": "Mute Exception", + "group": "consumer", + "label": "consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": true, + "description": "If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace." + }, + "populateBodyWithForm": { + "index": 12, + "kind": "parameter", + "displayName": "Populate Body With Form", + "group": "consumer", + "label": "advanced,consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": true, + "description": "Whether to populate the message Body with a Map containing application/x-www-form-urlencoded form properties." + }, + "produces": { + "index": 13, + "kind": "parameter", + "displayName": "Produces", + "group": "consumer", + "label": "consumer", + "required": false, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "The content type this endpoint produces, such as application/xml or application/json." + }, + "returnHttpRequestHeaders": { + "index": 14, + "kind": "parameter", + "displayName": "Return Http Request Headers", + "group": "consumer", + "label": "advanced,consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "description": "Whether to include HTTP request headers (Accept, User-Agent, etc.) into HTTP response produced by this endpoint." + }, + "useCookieHandler": { + "index": 15, + "kind": "parameter", + "displayName": "Use Cookie Handler", + "group": "consumer", + "label": "advanced,consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "description": "Whether to enable the Cookie Handler that allows Cookie addition, expiry, and retrieval (currently only supported by camel-platform-http-vertx)" + }, + "useStreaming": { + "index": 16, + "kind": "parameter", + "displayName": "Use Streaming", + "group": "consumer", + "label": "advanced,consumer", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "description": "Whether to use streaming for large requests and responses (currently only supported by camel-platform-http-vertx)" + }, + "bridgeErrorHandler": { + "index": 17, + "kind": "parameter", + "displayName": "Bridge Error Handler", + "group": "consumer (advanced)", + "label": "consumer,advanced", + "required": false, + "type": "boolean", + "javaType": "boolean", + "deprecated": false, + "autowired": false, + "secret": false, + "defaultValue": false, + "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored." + }, + "exceptionHandler": { + "index": 18, + "kind": "parameter", + "displayName": "Exception Handler", + "group": "consumer (advanced)", + "label": "consumer,advanced", + "required": false, + "type": "object", + "javaType": "org.apache.camel.spi.ExceptionHandler", + "optionalPrefix": "consumer.", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored." + }, + "exchangePattern": { + "index": 19, + "kind": "parameter", + "displayName": "Exchange Pattern", + "group": "consumer (advanced)", + "label": "consumer,advanced", + "required": false, + "type": "object", + "javaType": "org.apache.camel.ExchangePattern", + "enum": [ + "InOnly", + "InOut" + ], + "deprecated": false, + "autowired": false, + "secret": false, + "description": "Sets the exchange pattern when the consumer creates an exchange." + }, + "fileNameExtWhitelist": { + "index": 20, + "kind": "parameter", + "displayName": "File Name Ext Whitelist", + "group": "consumer (advanced)", + "label": "consumer,advanced", + "required": false, + "type": "string", + "javaType": "java.lang.String", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "A comma or whitespace separated list of file extensions. Uploads having these extensions will be stored locally. Null value or asterisk () will allow all files." + }, + "headerFilterStrategy": { + "index": 21, + "kind": "parameter", + "displayName": "Header Filter Strategy", + "group": "advanced", + "label": "advanced", + "required": false, + "type": "object", + "javaType": "org.apache.camel.spi.HeaderFilterStrategy", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "To use a custom HeaderFilterStrategy to filter headers to and from Camel message." + }, + "platformHttpEngine": { + "index": 22, + "kind": "parameter", + "displayName": "Platform Http Engine", + "group": "advanced", + "label": "advanced", + "required": false, + "type": "object", + "javaType": "org.apache.camel.component.platform.http.spi.PlatformHttpEngine", + "deprecated": false, + "autowired": false, + "secret": false, + "description": "An HTTP Server engine implementation to serve the requests of this endpoint." + } + } +} \ No newline at end of file