blob: 189fd0cfc7def21db7825a8a54cfbd42f0e2139b [file] [log] [blame]
{"component":{"kind":"component","name":"thrift","title":"Thrift","description":"Call and expose remote procedures (RPC) with Apache Thrift data format and serialization mechanism.","deprecated":false,"firstVersion":"2.20.0","label":"rpc,transformation","javaType":"org.apache.camel.component.thrift.ThriftComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-thrift","version":"3.18.1","scheme":"thrift","extendsScheme":"","syntax":"thrift:host:port/service","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelThriftMethodName":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Method name handled by the consumer service","constantName":"org.apache.camel.component.thrift.ThriftConstants#THRIFT_METHOD_NAME_HEADER"}},"properties":{"host":{"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server host name. This is localhost or 0.0.0.0 (if not defined) when being a consumer or remote server host name when using producer."},"port":{"kind":"path","displayName":"Port","group":"common","label":"","required":true,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server port"},"service":{"kind":"path","displayName":"Service","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Fully qualified service name from the thrift descriptor file (package dot service definition name)"},"compressionType":{"kind":"parameter","displayName":"Compression Type","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftCompressionType","enum":["NONE","ZLIB"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Protocol compression mechanism type"},"exchangeProtocol":{"kind":"parameter","displayName":"Exchange Protocol","group":"common","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftExchangeProtocol","enum":["BINARY","JSON","SJSON","COMPACT"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"BINARY","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Exchange protocol serialization type"},"clientTimeout":{"kind":"parameter","displayName":"Client Timeout","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Client timeout for consumers"},"maxPoolSize":{"kind":"parameter","displayName":"Max Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server consumer max thread pool size"},"poolSize":{"kind":"parameter","displayName":"Pool Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift server consumer initial thread pool size"},"bridgeErrorHandler":{"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 occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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":{"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":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"method":{"kind":"parameter","displayName":"Method","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"The Thrift invoked method name"},"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."},"synchronous":{"kind":"parameter","displayName":"Synchronous","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"negotiationType":{"kind":"parameter","displayName":"Negotiation Type","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.thrift.ThriftNegotiationType","enum":["PLAINTEXT","SSL","SASL"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PLAINTEXT","configurationClass":"org.apache.camel.component.thrift.ThriftConfiguration","configurationField":"configuration","description":"Security negotiation type"},"sslParameters":{"kind":"parameter","displayName":"Ssl 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.thrift.ThriftConfiguration","configurationField":"configuration","description":"Configuration parameters for SSL/TLS security negotiation"}}}