Interface WebhookEndpointBuilderFactory.WebhookEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- WebhookEndpointBuilderFactory
public static interface WebhookEndpointBuilderFactory.WebhookEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Webhook component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebhookEndpointBuilderFactory.AdvancedWebhookEndpointBuilder
advanced()
default WebhookEndpointBuilderFactory.WebhookEndpointBuilder
webhookAutoRegister(boolean webhookAutoRegister)
Automatically register the webhook at startup and unregister it on shutdown.default WebhookEndpointBuilderFactory.WebhookEndpointBuilder
webhookAutoRegister(String webhookAutoRegister)
Automatically register the webhook at startup and unregister it on shutdown.default WebhookEndpointBuilderFactory.WebhookEndpointBuilder
webhookBasePath(String webhookBasePath)
The first (base) path element where the webhook will be exposed.default WebhookEndpointBuilderFactory.WebhookEndpointBuilder
webhookComponentName(String webhookComponentName)
The Camel Rest component to use for the REST transport, such as netty-http.default WebhookEndpointBuilderFactory.WebhookEndpointBuilder
webhookExternalUrl(String webhookExternalUrl)
The URL of the current service as seen by the webhook provider.default WebhookEndpointBuilderFactory.WebhookEndpointBuilder
webhookPath(String webhookPath)
The path where the webhook endpoint will be exposed (relative to basePath, if any).
-
-
-
Method Detail
-
advanced
default WebhookEndpointBuilderFactory.AdvancedWebhookEndpointBuilder advanced()
-
webhookAutoRegister
default WebhookEndpointBuilderFactory.WebhookEndpointBuilder 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
-
webhookAutoRegister
default WebhookEndpointBuilderFactory.WebhookEndpointBuilder webhookAutoRegister(String webhookAutoRegister)
Automatically register the webhook at startup and unregister it on shutdown. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
webhookAutoRegister
- the value to set- Returns:
- the dsl builder
-
webhookBasePath
default WebhookEndpointBuilderFactory.WebhookEndpointBuilder 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 WebhookEndpointBuilderFactory.WebhookEndpointBuilder 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 WebhookEndpointBuilderFactory.WebhookEndpointBuilder 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 WebhookEndpointBuilderFactory.WebhookEndpointBuilder 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
-
-