| {"component":{"kind":"component","name":"asterisk","title":"Asterisk","description":"Interact with Asterisk PBX Server.","deprecated":false,"firstVersion":"2.18.0","label":"voip","javaType":"org.apache.camel.component.asterisk.AsteriskComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-asterisk","version":"3.18.1","scheme":"asterisk","extendsScheme":"","syntax":"asterisk:name","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelAsteriskEventName":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"Simple name of the event","description":"The name of the Asterisk event.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#EVENT_NAME"},"CamelAsteriskExtension":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The extension to query in case of an ExtensionStateAction.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#EXTENSION"},"CamelAsteriskContext":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the context that contains the extension to query in case of an ExtensionStateAction.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#CONTEXT"},"CamelAsteriskAction":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.asterisk.AsteriskAction","enum":["QUEUE_STATUS","SIP_PEERS","EXTENSION_STATE"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Asterisk action to do.","constantName":"org.apache.camel.component.asterisk.AsteriskConstants#ACTION"}},"properties":{"name":{"kind":"path","displayName":"Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of component"},"hostname":{"kind":"parameter","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The hostname of the asterisk server"},"password":{"kind":"parameter","displayName":"Password","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Login password"},"username":{"kind":"parameter","displayName":"Username","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Login username"},"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."},"action":{"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.asterisk.AsteriskAction","enum":["QUEUE_STATUS","SIP_PEERS","EXTENSION_STATE"],"deprecated":false,"autowired":false,"secret":false,"description":"What action to perform such as getting queue status, sip peers or extension state."},"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."}}} |