Chapter 20. Has Header Filter Action

Filter based on the presence of one header

20.1. Configuration Options

The following table summarizes the configuration options available for the has-header-filter-action Kamelet:

PropertyNameDescriptionTypeDefaultExample

name *

Header Name

The header name to evaluate. The header name must be passed by the source Kamelet. For Knative only, the name of the header requires a CloudEvent (ce-) prefix.

string

 

"headerName"

Note

Fields marked with an asterisk (*) are mandatory.

20.2. Dependencies

At runtime, the has-header-filter-action Kamelet relies upon the presence of the following dependencies:

  • camel:core
  • camel:kamelet

20.3. Usage

This section describes how you can use the has-header-filter-action.

20.3.1. Knative Action

You can use the has-header-filter-action Kamelet as an intermediate step in a Knative binding. For this example, the Knative mychannel provides a message header named ce-foo. The CloudEvents (ce-) prefix for the header name is required. The example in the Insert Header action shows how to add a message header to data.

has-header-filter-action-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: has-header-filter-action-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  steps:
  - ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: has-header-filter-action
    properties:
      name: "ce-foo"
  sink:
    uri: "log:info"

20.3.1.1. Prerequisites

  • Make sure you have "Red Hat Integration - Camel K" installed on the OpenShift cluster that you’re connected to.
  • The source Kamelet in the Kamelet Binding must pass a header with the name that you specify in the has-header-filter-action Kamelet’s name property.

20.3.1.2. Procedure for using the cluster CLI

  1. Save the has-header-filter-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command: 

    oc apply -f has-header-filter-action-binding.yaml

20.3.1.3. Procedure for using the Kamel CLI

Configure and run the action by using the following command: 

kamel bind timer-source?message=Hello --step has-header-filter-action -p "step-0.name=ce-foo" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

20.3.2. Kafka Action

You can use the has-header-filter-action Kamelet as an intermediate step in a Kafka binding. For this example, the kafka-source Kamelet provides a message header named foo. The example in the Insert Header action shows how to add a message header to data.

has-header-filter-action-binding.yaml

    apiVersion: camel.apache.org/v1alpha1
    kind: KameletBinding
    metadata:
      name: has-header-filter-action-binding
    spec:
      source:
        ref:
          kind: Kamelet
          apiVersion: camel.apache.org/v1alpha1
          name: kafka-source
        properties:
          bootstrapServers: "my-cluster-kafka-bootstrap.myproject.svc:9092"
          password: "XXX"
          topic: "my-topic"
          user: "XXX"
          securityProtocol: "PLAINTEXT"
      steps:
      - ref:
          kind: Kamelet
          apiVersion: camel.apache.org/v1alpha1
          name: has-header-filter-action
        properties:
          name: "foo"
      sink:
        uri: "log:info"

20.3.2.1. Prerequisites

  • Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace.
  • Make sure that you have "Red Hat Integration - Camel K" installed on the OpenShift cluster that you’re connected to.

20.3.2.2. Procedure for using the cluster CLI

  1. Save the has-header-filter-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the action by using the following command: 

    oc apply -f has-header-filter-action-binding.yaml

20.3.2.3. Procedure for using the Kamel CLI

Configure and run the action by using the following command: 

kamel bind timer-source?message=Hello --step has-header-filter-action -p "step-0.name=foo" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

20.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/blob/kamelet-catalog-1.6/has-header-filter-action.kamelet.yaml