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.WebhookComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.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.default WebhookComponentBuilderFactory.WebhookComponentBuilder
configuration(org.apache.camel.component.webhook.WebhookConfiguration configuration)
Set the default configuration for the webhook meta-component.default WebhookComponentBuilderFactory.WebhookComponentBuilder
webhookAutoRegister(boolean webhookAutoRegister)
Automatically register the webhook at startup and unregister it on shutdown.default WebhookComponentBuilderFactory.WebhookComponentBuilder
webhookBasePath(String webhookBasePath)
The first (base) path element where the webhook will be exposed.default WebhookComponentBuilderFactory.WebhookComponentBuilder
webhookComponentName(String webhookComponentName)
The Camel Rest component to use for the REST transport, such as netty-http.default WebhookComponentBuilderFactory.WebhookComponentBuilder
webhookExternalUrl(String webhookExternalUrl)
The URL of the current service as seen by the webhook provider.default WebhookComponentBuilderFactory.WebhookComponentBuilder
webhookPath(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: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
webhookAutoRegister
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookAutoRegister(boolean webhookAutoRegister)
Automatically register the webhook at startup and unregister it on shutdown. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
webhookAutoRegister
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: consumer- Parameters:
webhookBasePath
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: consumer- Parameters:
webhookComponentName
- the value to set- Returns:
- the dsl builder
-
webhookExternalUrl
default WebhookComponentBuilderFactory.WebhookComponentBuilder webhookExternalUrl(String webhookExternalUrl)
The URL of the current service as seen by the webhook provider. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
webhookExternalUrl
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: consumer- Parameters:
webhookPath
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default WebhookComponentBuilderFactory.WebhookComponentBuilder autowiredEnabled(boolean autowiredEnabled)
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. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
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: <code>org.apache.camel.component.webhook.WebhookConfiguration</code> type. Group: advanced- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
-