Skip to content

Commit 8e9da88

Browse files
pascalwilbrinkpascalwilbrink
committed
Feat: Added Java SDK
1 parent f5940f6 commit 8e9da88

File tree

191 files changed

+15499
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+15499
-1
lines changed

‎.github/workflows/test.yml‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,26 @@ jobs:
8989

9090
- name: Run tests
9191
working-directory: typescript-sdk
92-
run: pnpm run test
92+
run: pnpm run test
93+
94+
java:
95+
name: Java SDK Tests
96+
runs-on: ubuntu-latest
97+
98+
defaults:
99+
run:
100+
working-directory: sdks/community/java
101+
102+
steps:
103+
- name: Checkout code
104+
uses: actions/checkout@v4
105+
106+
- name: Set up Java
107+
uses: actions/setup-java@v4
108+
with:
109+
distribution: 'temurin'
110+
java-version: '17'
111+
cache: 'maven'
112+
113+
- name: Run tests
114+
run: mvn -B -ntp test

‎docs/docs.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,17 @@
108108
"pages": ["sdk/python/encoder/overview"]
109109
}
110110
]
111+
},
112+
{
113+
"group": "Java",
114+
"pages": [
115+
{
116+
"group": "Core",
117+
"pages": [
118+
"sdk/java/core/overview"
119+
]
120+
}
121+
]
111122
}
112123
]
113124
}

‎docs/sdk/java/core/overview.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Java SDK Overview"
3+
description: "Core concepts in the Agent User Interaction Protocol SDK"
4+
---
5+
6+
# ag-ui/core
7+
8+
9+
The Agent User Interaction Protocol SDK uses a streaming event-based
10+
architecture with strongly typed data structures. This package provides the
11+
foundation for connecting to agent systems.
12+
13+
```xml
14+
<dependency>
15+
<groupId>io.workm8.agui4j</groupId>
16+
<artifactId>core</artifactId>
17+
<version>0.0.1</version>
18+
</dependency>
19+
```

‎docs/sdk/java/overview.mdx‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: "Java SDK Overview"
3+
description: "Connect to AG-UI agents using the official Java SDK"
4+
---
5+
6+
The AG-UI Java SDK provides a robust and idiomatic way to connect Java applications to AG-UI agents.
7+
It enables real-time streaming communication through Server-Sent Events (SSE), allowing you to build intelligent agent-powered applications with Go.
8+
9+
## Installation
10+
11+
Add the SDK as a maven dependency:
12+
13+
```xml
14+
```
15+
16+
## Quick Start
17+
18+
19+
## Package Structure
20+
21+
The Java SDK is organized into several focused packages, each handling a specific aspect of the AG-UI protocol:
22+
23+
### Core Package (`core/events`)
24+
The foundation of the SDK, providing event types, interfaces, and decoding capabilities. This package defines all the event structures used in AG-UI communication, including text messages, tool calls, state management, and lifecycle events.
25+
26+
27+
28+
## Next Steps
29+
30+
Explore the detailed documentation for each package to learn more about specific features and advanced usage:
31+
32+
<Card
33+
title="Core Concepts"
34+
icon="cube"
35+
href="/sdk/go/core/overview"
36+
color="#3B82F6"
37+
iconType="solid"
38+
>
39+
Learn about events, types, and the foundational concepts of the AG-UI protocol
40+
</Card>
41+
42+
<Card
43+
title="Client Connectivity"
44+
icon="cube"
45+
href="/sdk/go/client/overview"
46+
color="#3B82F6"
47+
iconType="solid"
48+
>
49+
Detailed guide on SSE client configuration, streaming, and connection management
50+
</Card>
51+
52+
<Card
53+
title="Encoding & Serialization"
54+
icon="cube"
55+
href="/sdk/go/encoding/overview"
56+
color="#3B82F6"
57+
iconType="solid"
58+
>
59+
Work with different encodings, content negotiation, and SSE server implementation
60+
</Card>
61+
62+
<Card
63+
title="Error Handling"
64+
icon="cube"
65+
href="/sdk/go/errors/overview"
66+
color="#3B82F6"
67+
iconType="solid"
68+
>
69+
Comprehensive error handling patterns, retry logic, and recovery strategies
70+
</Card>

‎sdks/community/java/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
target/
2+
*.iml

‎sdks/community/java/CHANGELOG.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changelog
2+
3+
## 1.0.0 (2025-08-09)
4+
5+
6+
### Bug Fixes
7+
8+
* added parent package in release-please ([f656159](https://github.com/Work-m8/ag-ui-4j/commit/f656159962181119786008ef685c50db95aa519e))
9+
* Fix release-please config ([56e1ffc](https://github.com/Work-m8/ag-ui-4j/commit/56e1ffcc1ca64756be110a7cecdae4a0c41f4c24))
10+
* Fix release-please permissions ([d08ca12](https://github.com/Work-m8/ag-ui-4j/commit/d08ca121d7ea7484cc8bac53a897822e78bb758b))
11+
12+
## Changelog
13+
14+
All notable changes to this project will be documented in this file.
15+
16+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
17+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

‎sdks/community/java/CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)