META-INF.org.apache.camel.component.olingo4.olingo4.json Maven / Gradle / Ivy
The newest version!
{
"component": {
"kind": "component",
"name": "olingo4",
"title": "Olingo4",
"description": "Communicate with OData 4.0 services using Apache Olingo OData API.",
"deprecated": false,
"firstVersion": "2.19.0",
"label": "cloud",
"javaType": "org.apache.camel.component.olingo4.Olingo4Component",
"supportLevel": "Stable",
"groupId": "org.apache.camel",
"artifactId": "camel-olingo4",
"version": "4.8.0",
"scheme": "olingo4",
"extendsScheme": "",
"syntax": "olingo4:apiName\/methodName",
"async": false,
"api": true,
"apiSyntax": "apiName\/methodName",
"consumerOnly": false,
"producerOnly": false,
"lenientProperties": false,
"remote": true
},
"componentProperties": {
"configuration": { "index": 0, "kind": "property", "displayName": "Configuration", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.Olingo4Configuration", "deprecated": false, "autowired": false, "secret": false, "description": "To use the shared configuration" },
"connectTimeout": { "index": 1, "kind": "property", "displayName": "Connect Timeout", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 30000, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)" },
"contentType": { "index": 2, "kind": "property", "displayName": "Content Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "application\/json;charset=utf-8", "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Content-Type header value can be used to specify JSON or XML message format, defaults to application\/json;charset=utf-8" },
"filterAlreadySeen": { "index": 3, "kind": "property", "displayName": "Filter Already Seen", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Set this to true to filter out results that have already been communicated by this component." },
"httpHeaders": { "index": 4, "kind": "property", "displayName": "Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Custom HTTP headers to inject into every request, this could include OAuth tokens, etc." },
"proxy": { "index": 5, "kind": "property", "displayName": "Proxy", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.http.HttpHost", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "HTTP proxy server configuration" },
"serviceUri": { "index": 6, "kind": "property", "displayName": "Service Uri", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Target OData service base URI, e.g. http:\/\/services.odata.org\/OData\/OData.svc" },
"socketTimeout": { "index": 7, "kind": "property", "displayName": "Socket Timeout", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 30000, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)" },
"bridgeErrorHandler": { "index": 8, "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "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." },
"splitResult": { "index": 9, "kind": "property", "displayName": "Split Result", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false." },
"lazyStartProducer": { "index": 10, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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." },
"autowiredEnabled": { "index": 11, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
"httpAsyncClientBuilder": { "index": 12, "kind": "property", "displayName": "Http Async Client Builder", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.http.impl.nio.client.HttpAsyncClientBuilder", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely" },
"httpClientBuilder": { "index": 13, "kind": "property", "displayName": "Http Client Builder", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.http.impl.client.HttpClientBuilder", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely" },
"sslContextParameters": { "index": 14, "kind": "property", "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, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "To configure security using SSLContextParameters" },
"useGlobalSslContextParameters": { "index": 15, "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." }
},
"headers": {
"CamelOlingo4.responseHttpHeaders": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Map", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The response Http headers", "constantName": "org.apache.camel.component.olingo4.internal.Olingo4Constants#FULL_RESPONSE_HTTP_HEADERS" }
},
"properties": {
"apiName": { "index": 0, "kind": "path", "displayName": "Api Name", "group": "common", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.olingo4.internal.Olingo4ApiName", "enum": [ "DEFAULT" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "What kind of operation to perform" },
"methodName": { "index": 1, "kind": "path", "displayName": "Method Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "What sub operation to use for the selected operation" },
"connectTimeout": { "index": 2, "kind": "parameter", "displayName": "Connect Timeout", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 30000, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)" },
"contentType": { "index": 3, "kind": "parameter", "displayName": "Content Type", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "application\/json;charset=utf-8", "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Content-Type header value can be used to specify JSON or XML message format, defaults to application\/json;charset=utf-8" },
"filterAlreadySeen": { "index": 4, "kind": "parameter", "displayName": "Filter Already Seen", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Set this to true to filter out results that have already been communicated by this component." },
"httpHeaders": { "index": 5, "kind": "parameter", "displayName": "Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Custom HTTP headers to inject into every request, this could include OAuth tokens, etc." },
"inBody": { "index": 6, "kind": "parameter", "displayName": "In Body", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the name of a parameter to be passed in the exchange In Body" },
"proxy": { "index": 7, "kind": "parameter", "displayName": "Proxy", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.http.HttpHost", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "HTTP proxy server configuration" },
"serviceUri": { "index": 8, "kind": "parameter", "displayName": "Service Uri", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Target OData service base URI, e.g. http:\/\/services.odata.org\/OData\/OData.svc" },
"socketTimeout": { "index": 9, "kind": "parameter", "displayName": "Socket Timeout", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 30000, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)" },
"sendEmptyMessageWhenIdle": { "index": 10, "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
"splitResult": { "index": 11, "kind": "parameter", "displayName": "Split Result", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false." },
"bridgeErrorHandler": { "index": 12, "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": 13, "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": 14, "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." },
"pollStrategy": { "index": 15, "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel." },
"lazyStartProducer": { "index": 16, "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." },
"httpAsyncClientBuilder": { "index": 17, "kind": "parameter", "displayName": "Http Async Client Builder", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.http.impl.nio.client.HttpAsyncClientBuilder", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely" },
"httpClientBuilder": { "index": 18, "kind": "parameter", "displayName": "Http Client Builder", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.http.impl.client.HttpClientBuilder", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely" },
"backoffErrorThreshold": { "index": 19, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." },
"backoffIdleThreshold": { "index": 20, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." },
"backoffMultiplier": { "index": 21, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and\/or backoffErrorThreshold must also be configured." },
"delay": { "index": 22, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." },
"greedy": { "index": 23, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." },
"initialDelay": { "index": 24, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." },
"repeatCount": { "index": 25, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." },
"runLoggingLevel": { "index": 26, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the logging level for that." },
"scheduledExecutorService": { "index": 27, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." },
"scheduler": { "index": 28, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" },
"schedulerProperties": { "index": 29, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." },
"startScheduler": { "index": 30, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." },
"timeUnit": { "index": 31, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
"useFixedDelay": { "index": 32, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." },
"sslContextParameters": { "index": 33, "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, "configurationClass": "org.apache.camel.component.olingo4.Olingo4Configuration", "configurationField": "configuration", "description": "To configure security using SSLContextParameters" }
},
"apis": {
"DEFAULT": { "consumerOnly": false, "producerOnly": false, "description": "Olingo4 Client Api Interface", "methods": { "action": { "description": "Calls a OData action", "signatures": [ "void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "batch": { "description": "Executes a batch request", "signatures": [ "void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler> responseHandler)" ] }, "create": { "description": "Creates a new OData resource", "signatures": [ "void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "delete": { "description": "Deletes an OData resource and invokes callback with org", "signatures": [ "void delete(String resourcePath, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "merge": { "description": "Patches\/merges an OData resource using HTTP MERGE", "signatures": [ "void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "patch": { "description": "Patches\/merges an OData resource using HTTP PATCH", "signatures": [ "void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "read": { "description": "Reads an OData resource and invokes callback with appropriate result", "signatures": [ "void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "update": { "description": "Updates an OData resource", "signatures": [ "void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] }, "uread": { "description": "Reads an OData resource and invokes callback with the unparsed input stream", "signatures": [ "void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map queryParams, java.util.Map endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)" ] } } }
},
"apiProperties": {
"DEFAULT": { "methods": { "action": { "properties": { "data": { "index": 0, "kind": "parameter", "displayName": "Data", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "Action data", "optional": true }, "edm": { "index": 1, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm", "optional": true }, "endpointHttpHeaders": { "index": 2, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Resource path to action", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Org.apache.olingo.client.api.domain.ClientEntity callback handler", "optional": true } } }, "batch": { "properties": { "data": { "index": 0, "kind": "parameter", "displayName": "Data", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "Ordered org.apache.camel.component.olingo4.api.batch.Olingo4BatchRequest list", "optional": true }, "edm": { "index": 1, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm", "optional": true }, "endpointHttpHeaders": { "index": 2, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "responseHandler": { "index": 3, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Callback handler", "optional": true } } }, "create": { "properties": { "data": { "index": 0, "kind": "parameter", "displayName": "Data", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "Request data", "optional": true }, "edm": { "index": 1, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm", "optional": true }, "endpointHttpHeaders": { "index": 2, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Resource path to create", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Callback handler", "optional": true } } }, "delete": { "properties": { "endpointHttpHeaders": { "index": 0, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "resourcePath": { "index": 1, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Resource path for Entry", "optional": false }, "responseHandler": { "index": 2, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Org.apache.olingo.commons.api.http.HttpStatusCode callback handler", "optional": true } } }, "merge": { "properties": { "data": { "index": 0, "kind": "parameter", "displayName": "Data", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "Patch\/merge data", "optional": true }, "edm": { "index": 1, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm", "optional": true }, "endpointHttpHeaders": { "index": 2, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Resource path to update", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Org.apache.olingo.client.api.domain.ClientEntity callback handler", "optional": true } } }, "patch": { "properties": { "data": { "index": 0, "kind": "parameter", "displayName": "Data", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "Patch\/merge data", "optional": true }, "edm": { "index": 1, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm", "optional": true }, "endpointHttpHeaders": { "index": 2, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Resource path to update", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Org.apache.olingo.client.api.domain.ClientEntity callback handler", "optional": true } } }, "read": { "properties": { "edm": { "index": 0, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm, read from calling read(null, $metdata, null, responseHandler)", "optional": true }, "endpointHttpHeaders": { "index": 1, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "queryParams": { "index": 2, "kind": "parameter", "displayName": "Query Params", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "OData query params http:\/\/docs.oasis-open.org\/odata\/odata\/v4.0\/odata-v4.0-part1-protocol.html#_Toc453752288", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "OData Resource path", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Callback handler", "optional": true } } }, "update": { "properties": { "data": { "index": 0, "kind": "parameter", "displayName": "Data", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "Updated data", "optional": true }, "edm": { "index": 1, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm", "optional": true }, "endpointHttpHeaders": { "index": 2, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Resource path to update", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Org.apache.olingo.client.api.domain.ClientEntity callback handler", "optional": true } } }, "uread": { "properties": { "edm": { "index": 0, "kind": "parameter", "displayName": "Edm", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.olingo.commons.api.edm.Edm", "deprecated": false, "autowired": false, "secret": false, "description": "Service Edm, read from calling read(null, $metdata, null, responseHandler)", "optional": true }, "endpointHttpHeaders": { "index": 1, "kind": "parameter", "displayName": "Endpoint Http Headers", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "HTTP Headers to add\/override the component versions", "optional": true }, "queryParams": { "index": 2, "kind": "parameter", "displayName": "Query Params", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map", "deprecated": false, "autowired": false, "secret": false, "description": "OData query params http:\/\/docs.oasis-open.org\/odata\/odata\/v4.0\/odata-v4.0-part1-protocol.html#_Toc453752288", "optional": true }, "resourcePath": { "index": 3, "kind": "parameter", "displayName": "Resource Path", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "OData Resource path", "optional": false }, "responseHandler": { "index": 4, "kind": "parameter", "displayName": "Response Handler", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.olingo4.api.Olingo4ResponseHandler", "deprecated": false, "autowired": false, "secret": false, "description": "Callback handler", "optional": true } } } } }
}
}