Interface WebhookComponentBuilderFactory.WebhookComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.webhook.WebhookComponent>
- All Known Implementing Classes:
WebhookComponentBuilderFactory.WebhookComponentBuilderImpl
- Enclosing interface:
- WebhookComponentBuilderFactory
public static interface WebhookComponentBuilderFactory.WebhookComponentBuilder extends ComponentBuilder<org.apache.camel.component.webhook.WebhookComponent>
Builder for the Webhook component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebhookComponentBuilderFactory.WebhookComponentBuilderbasicPropertyBinding(boolean basicPropertyBinding)Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.default WebhookComponentBuilderFactory.WebhookComponentBuilderbridgeErrorHandler(boolean bridgeErrorHandler)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.default WebhookComponentBuilderFactory.WebhookComponentBuilderconfiguration(org.apache.camel.component.webhook.WebhookConfiguration configuration)Set the default configuration for the webhook meta-component.default WebhookComponentBuilderFactory.WebhookComponentBuilderwebhookAutoRegister(boolean webhookAutoRegister)Automatically register the webhook at startup and unregister it on shutdown.default WebhookComponentBuilderFactory.WebhookComponentBuilderwebhookBasePath(String webhookBasePath)The first (base) path element where the webhook will be exposed.default WebhookComponentBuilderFactory.WebhookComponentBuilderwebhookComponentName(String webhookComponentName)The Camel Rest component to use for the REST transport, such as netty-http.default WebhookComponentBuilderFactory.WebhookComponentBuilderwebhookExternalUrl(String webhookExternalUrl)The URL of the current service as seen by the webhook provider.default WebhookComponentBuilderFactory.WebhookComponentBuilderwebhookPath(String webhookPath)The path where the webhook endpoint will be exposed (relative to basePath, if any).-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
bridgeErrorHandler
default WebhookComponentBuilderFactory.WebhookComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
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. The option is a:booleantype. Default: false Group: consumer
-
webhookAutoRegister
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookAutoRegister(boolean webhookAutoRegister)
Automatically register the webhook at startup and unregister it on shutdown. The option is a:booleantype. Default: true Group: consumer
-
webhookBasePath
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookBasePath(String webhookBasePath)
The first (base) path element where the webhook will be exposed. It's a good practice to set it to a random string, so that it cannot be guessed by unauthorized parties. The option is a:java.lang.Stringtype. Group: consumer
-
webhookComponentName
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookComponentName(String webhookComponentName)
The Camel Rest component to use for the REST transport, such as netty-http. The option is a:java.lang.Stringtype. Group: consumer
-
webhookExternalUrl
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookExternalUrl(String webhookExternalUrl)
The URL of the current service as seen by the webhook provider. The option is a:java.lang.Stringtype. Group: consumer
-
webhookPath
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookPath(String webhookPath)
The path where the webhook endpoint will be exposed (relative to basePath, if any). The option is a:java.lang.Stringtype. Group: consumer
-
basicPropertyBinding
default WebhookComponentBuilderFactory.WebhookComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a:booleantype. Default: false Group: advanced
-
configuration
default WebhookComponentBuilderFactory.WebhookComponentBuilder configuration(org.apache.camel.component.webhook.WebhookConfiguration configuration)
Set the default configuration for the webhook meta-component. The option is a:org.apache.camel.component.webhook.WebhookConfigurationtype. Group: advanced
-
-