https://github.com/americanexpress/jakapu

Config driven SDK to publish events into any Kafka topic without writing code
https://github.com/americanexpress/jakapu

java kafka rest spring

Last synced: about 2 months ago
JSON representation

Config driven SDK to publish events into any Kafka topic without writing code

• Host: GitHub
• URL: https://github.com/americanexpress/jakapu
• Owner: americanexpress
• License: apache-2.0
• Created: 2020-04-16T22:52:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-03T18:15:39.000Z (almost 3 years ago)
• Last Synced: 2024-04-14T13:05:32.922Z (9 months ago)
• Topics: java, kafka, rest, spring
• Language: Java
• Homepage:
• Size: 90.8 KB
• Stars: 3
• Watchers: 8
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


Java Kafka Publisher (JaKaPu)





  



**Jakapu is a config driven SDK to publish events into any Kafka topic without writing code**

## ✨ Features

- Build a Kafka Publisher with a single @annotation

- Convert your existing Springboot app to a Kafka publisher

- Publish message into multiple kafka topics

- Route messages into multiple kafka topics based on a header key

- Validate the kafka header and their values before publishing message into kafka

- Configuration driven Kafka broker, topic configuration

- Publish to kafka with ssl enabled or disabled 

- Also provides a REST API end point @/jakapu/publish to publish messages into kakfa

## 📖 Prerequisites

- Maven 3+

- Java 8+

- Spring framework

- Kafka Topic

            

## 🤹‍ Getting Started

##### Add maven dependency

```java

    com.americanexpress.jakapu

    jakapu

    ${latest.version}

```

##### Add @EnableJakapu as a dependency annotation on Spring Boot Main Application class.

```java

     @EnableJakapu

      public class SampleSpringApplication {

      public static void main(String[] args) {

          logger.info("Spring Boot Sample App Started.............");

          ApplicationContext app = SpringApplication.run(SampleSpringApplication.class);

      }

  }

```

##### Configure :

    - dynamically add any number of topics to your configuration under **jakapu.psf.publisher.topics** 

    - define mandatory kafka header attribute names and their validation pattern(**jakapu.psf.publisher.payload.headerAtribute**)

    - header-based topic routing can be added in the configuration under **Jakapu.psf.publisher.headerTopicMap**

```yaml

jakapu:

  psf:

    publisher:

      topics:

      - name: Topic1

        id: t1

        numPartitions: 4

        replication-factor: 1

      - name: Topic2

        id: t2

        numPartitions: 8

        replication-factor: 1

    

    payload:

      headerAttribute:

        source-type: "re(jakapu.psf.payload.headerTopicMap)"

        event-type: "rx(\\w{1,})" #Java Regex to validate the type of event. Accepts any string size more than 1.

        source-uniqueid: "rx(\\w{1,})" #Java Regex to validate string. Accepts any string size more than 1. 

        source-timestamp: "rx(\\d{13})" #Java Regex to validate timestamp. 13 digit number.

      headerTopicMap:

        MySource1: t1

        MySource2: t2

 ### kafka config related to broker, ssl, keystores etc

  kafka:

    security:

      enabled: false

      protocol: SSL

    ssl:

      protocol: TLSv1.2

      keystore:

        type: JKS

        location: your-private-keystore.jks

        password: $$$$

      key:

        password: $$$$

      truststore:

        location: client-truststore.jks

        password: $$$$

    bootstrap-servers: "yourkafka.domain.com"

```

##### To publish a message, autowire Publisher interface and then use the API call - **publisher.publish()**

```java

public class SampleKafkaPublisher {

    @Autowired

    private Publisher publisher;

    public send(String message) {

        Map headerMap = ... ; // add kafka headers that are mandatory/needed

        publisher.publish(headerMap, message);

    }

}

```

##### Example Publish Message using Curl to the inbuilt REST endpoint:

```unix

curl -H 'content-type: application/json' \

-H 'source-type: MySource1' \

-H 'event-type: TestEventType' \

-H 'source-uniqueid: 231324' \

-H 'source-timestamp: 1576020324880' \

--data '{"message":"test"}' \

https://hostname/jakapu/publish

```

## 🏆 Contributing

We welcome Your interest in the American Express Open Source Community on Github. Any Contributor to

any Open Source Project managed by the American Express Open Source Community must accept and sign

an Agreement indicating agreement to the terms below. Except for the rights granted in this 

Agreement to American Express and to recipients of software distributed by American Express, You

reserve all right, title, and interest, if any, in and to Your Contributions. Please

[fill out the Agreement](https://cla-assistant.io/americanexpress/jakapu).

## 🗝️ License

Any contributions made under this project will be governed by the

[Apache License 2.0](./LICENSE.txt).

## 🗣️ Code of Conduct

This project adheres to the [American Express Community Guidelines](./CODE_OF_CONDUCT.md). 

By participating, you are expected to honor these guidelines.