-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy patherror-handling.html
More file actions
450 lines (410 loc) · 19.5 KB
/
Copy patherror-handling.html
File metadata and controls
450 lines (410 loc) · 19.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from target/filtered-site/markdown/cookbook/error-handling.md at 2026-03-17
| Rendered using Apache Maven Fluido Skin 2.1.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>Error Handling Patterns – GitHub Copilot SDK :: Java</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-2.1.0.min.css" />
<link rel="stylesheet" href="../css/site.css" />
<link rel="stylesheet" href="../css/print.css" media="print" />
<script src="../js/apache-maven-fluido-2.1.0.min.js"></script>
<style>.github-fork-ribbon:before { background-color: gray; }</style>
</head>
<body class="topBarEnabled">
<a class="github-fork-ribbon right-top" href="https://github.com/github/copilot-sdk-java" data-ribbon="Fork me on GitHub">Fork me on GitHub</a>
<header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="../index.html">GitHub Copilot SDK for Java
</a>
<ul class="nav">
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../index.html">Introduction</a></li>
<li><a href="../getting-started.html">Getting Started</a></li>
<li><a href="../setup.html">Setup</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<li><a href="../mcp.html">MCP Servers</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
<li><a href="../advanced.html">Advanced Usage</a></li>
<li><a href="../apidocs/index.html">API Javadoc</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Guides <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../documentation.html#Basic_Usage">Basic Usage</a></li>
<li><a href="../documentation.html#Handling_Responses">Handling Responses</a></li>
<li><a href="../documentation.html#Streaming_Responses">Streaming</a></li>
<li><a href="../documentation.html#Choosing_a_Model">Choosing a Model</a></li>
<li><a href="../documentation.html#Session_Management">Session Management</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Advanced <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../advanced.html#Custom_Tools">Custom Tools</a></li>
<li><a href="../advanced.html#System_Messages">System Messages</a></li>
<li><a href="../advanced.html#File_Attachments">File Attachments</a></li>
<li><a href="../advanced.html#Bring_Your_Own_Key_.28BYOK.29">BYOK</a></li>
<li><a href="../advanced.html#Infinite_Sessions">Infinite Sessions</a></li>
<li><a href="../advanced.html#MCP_Servers">MCP Servers</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Cookbook <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="../cookbook/README.html">Overview</a></li>
<li><a>Error Handling</a></li>
<li><a href="../cookbook/multiple-sessions.html">Multiple Sessions</a></li>
<li><a href="../cookbook/managing-local-files.html">Managing Local Files</a></li>
<li><a href="../cookbook/pr-visualization.html">PR Visualization</a></li>
<li><a href="../cookbook/persisting-sessions.html">Persisting Sessions</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="../project-info.html">Project Information</a>
<ul class="dropdown-menu">
<li><a href="../dependencies.html">Dependencies</a></li>
<li><a href="../dependency-info.html">Maven Coordinates</a></li>
<li><a href="../distribution-management.html">Distribution Management</a></li>
<li><a href="../index.html">About</a></li>
<li><a href="../licenses.html">Licenses</a></li>
<li><a href="../plugin-management.html">Plugin Management</a></li>
<li><a href="../plugins.html">Plugins</a></li>
<li><a href="../scm.html">Source Code Management</a></li>
<li><a href="../summary.html">Summary</a></li>
<li><a href="../team.html">Team</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="../project-reports.html">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="../apidocs/index.html">Javadoc</a></li>
<li><a href="../surefire.html">Surefire</a></li>
<li><a href="../spotbugs.html">SpotBugs</a></li>
<li><a href="../taglist.html">Tag List</a></li>
<li><a href="../dependency-analysis.html">Dependency Analysis</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</header>
<div class="container-fluid container-fluid-top">
<header>
<div id="banner">
<div class="pull-left"></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2026-03-17<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 0.1.32-java.0<span class="divider">|</span></li>
<li><a href="../index.html">Home</a><span class="divider">/</span></li>
<li class="active">Error Handling Patterns</li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li><a href="../index.html">Introduction</a></li>
<li><a href="../getting-started.html">Getting Started</a></li>
<li><a href="../setup.html">Setup</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<li><a href="../mcp.html">MCP Servers</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
<li><a href="../advanced.html">Advanced Usage</a></li>
<li><a href="../apidocs/index.html">API Javadoc</a></li>
<li class="nav-header">Guides</li>
<li><a href="../documentation.html#Basic_Usage">Basic Usage</a></li>
<li><a href="../documentation.html#Handling_Responses">Handling Responses</a></li>
<li><a href="../documentation.html#Streaming_Responses">Streaming</a></li>
<li><a href="../documentation.html#Choosing_a_Model">Choosing a Model</a></li>
<li><a href="../documentation.html#Session_Management">Session Management</a></li>
<li class="nav-header">Advanced</li>
<li><a href="../advanced.html#Custom_Tools">Custom Tools</a></li>
<li><a href="../advanced.html#System_Messages">System Messages</a></li>
<li><a href="../advanced.html#File_Attachments">File Attachments</a></li>
<li><a href="../advanced.html#Bring_Your_Own_Key_.28BYOK.29">BYOK</a></li>
<li><a href="../advanced.html#Infinite_Sessions">Infinite Sessions</a></li>
<li><a href="../advanced.html#MCP_Servers">MCP Servers</a></li>
<li><a href="../hooks.html">Session Hooks</a></li>
<li class="nav-header">Cookbook</li>
<li><a href="../cookbook/README.html">Overview</a></li>
<li class="active"><a>Error Handling</a></li>
<li><a href="../cookbook/multiple-sessions.html">Multiple Sessions</a></li>
<li><a href="../cookbook/managing-local-files.html">Managing Local Files</a></li>
<li><a href="../cookbook/pr-visualization.html">PR Visualization</a></li>
<li><a href="../cookbook/persisting-sessions.html">Persisting Sessions</a></li>
<li class="nav-header">Project Documentation</li>
<li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li>
<li><a href="../project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
</nav>
<div class="well sidebar-nav">
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span10">
<section><a id="Error_Handling_Patterns"></a>
<h1>Error Handling Patterns</h1>
<p>Handle errors gracefully in your Copilot SDK applications.</p><section><a id="Prerequisites"></a>
<h2>Prerequisites</h2>
<p>Install <a href="https://www.jbang.dev/" class="externalLink">JBang</a> to run these examples:</p>
<pre class="prettyprint"><code class="language-bash"># macOS (using Homebrew)
brew install jbangdev/tap/jbang
# Linux/macOS (using curl)
curl -Ls https://sh.jbang.dev | bash -s - app setup
# Windows (using Scoop)
scoop install jbang
</code></pre></section><section><a id="Example_scenario"></a>
<h2>Example scenario</h2>
<p>You need to handle various error conditions like connection failures, timeouts, and invalid responses.</p></section><section><a id="Basic_error_handling"></a>
<h2>Basic error handling</h2>
<p><strong>Usage:</strong></p>
<pre class="prettyprint"><code class="language-bash">jbang BasicErrorHandling.java
</code></pre>
<p><strong>Code:</strong></p>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
public class BasicErrorHandling {
public static void main(String[] args) {
try (var client = new CopilotClient()) {
client.start().get();
var session = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get();
session.on(AssistantMessageEvent.class, msg -> {
System.out.println(msg.getData().content());
});
session.sendAndWait(new MessageOptions()
.setPrompt("Hello!")).get();
session.close();
} catch (Exception ex) {
System.err.println("Error: " + ex.getMessage());
ex.printStackTrace();
}
}
}
</code></pre></section><section><a id="Handling_specific_error_types"></a>
<h2>Handling specific error types</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
import java.util.concurrent.ExecutionException;
public class SpecificErrorHandling {
public static void startClient() {
try (var client = new CopilotClient()) {
client.start().get();
// ... use client ...
} catch (ExecutionException ex) {
Throwable cause = ex.getCause();
if (cause instanceof java.io.IOException) {
System.err.println("Copilot CLI not found. Please install it first.");
System.err.println("Details: " + cause.getMessage());
} else if (cause instanceof java.util.concurrent.TimeoutException) {
System.err.println("Could not connect to Copilot CLI server.");
System.err.println("Details: " + cause.getMessage());
} else {
System.err.println("Unexpected error: " + cause.getMessage());
cause.printStackTrace();
}
} catch (InterruptedException ex) {
Thread.currentThread().interrupt();
System.err.println("Operation interrupted: " + ex.getMessage());
} catch (Exception ex) {
System.err.println("Unexpected error: " + ex.getMessage());
ex.printStackTrace();
}
}
}
</code></pre></section><section><a id="Timeout_handling"></a>
<h2>Timeout handling</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public class TimeoutHandling {
public static void sendWithTimeout(CopilotSession session) {
try {
session.on(AssistantMessageEvent.class, msg -> {
System.out.println(msg.getData().content());
});
// Wait up to 30 seconds for response
session.sendAndWait(new MessageOptions()
.setPrompt("Complex question..."))
.get(30, TimeUnit.SECONDS);
} catch (TimeoutException ex) {
System.err.println("Request timed out");
} catch (Exception ex) {
System.err.println("Error: " + ex.getMessage());
}
}
}
</code></pre></section><section><a id="Aborting_a_request"></a>
<h2>Aborting a request</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
public class AbortRequest {
public static void abortAfterDelay(CopilotSession session) {
// Start a request (non-blocking)
session.send(new MessageOptions()
.setPrompt("Write a very long story..."));
// Schedule abort after 5 seconds
ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
scheduler.schedule(() -> {
try {
session.abort().get();
System.out.println("Request aborted");
} catch (Exception ex) {
System.err.println("Failed to abort: " + ex.getMessage());
} finally {
scheduler.shutdown();
}
}, 5, TimeUnit.SECONDS);
}
}
</code></pre></section><section><a id="Graceful_shutdown"></a>
<h2>Graceful shutdown</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
public class GracefulShutdown {
public static void main(String[] args) {
var client = new CopilotClient();
// Set up shutdown hook
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
System.out.println("\nShutting down...");
try {
client.close();
} catch (Exception ex) {
System.err.println("Error during shutdown: " + ex.getMessage());
}
}));
try {
client.start().get();
// ... do work ...
} catch (Exception ex) {
ex.printStackTrace();
}
}
}
</code></pre></section><section><a id="Try-with-resources_pattern"></a>
<h2>Try-with-resources pattern</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
public class TryWithResources {
public static void doWork() throws Exception {
try (var client = new CopilotClient()) {
client.start().get();
try (var session = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get()) {
session.on(AssistantMessageEvent.class, msg -> {
System.out.println(msg.getData().content());
});
session.sendAndWait(new MessageOptions()
.setPrompt("Hello!")).get();
// Session and client are automatically closed
}
}
}
}
</code></pre></section><section><a id="Handling_tool_errors"></a>
<h2>Handling tool errors</h2>
<pre class="prettyprint"><code class="language-java">//DEPS com.github:copilot-sdk-java:0.1.32-java.0
import com.github.copilot.sdk.*;
import com.github.copilot.sdk.events.*;
import com.github.copilot.sdk.json.*;
import java.util.Map;
import java.util.List;
import java.util.concurrent.CompletableFuture;
public class ToolErrorHandling {
public static void handleToolErrors() throws Exception {
var errorTool = ToolDefinition.create(
"get_user_location",
"Gets the user's location",
Map.of("type", "object", "properties", Map.of()),
invocation -> {
// Return an error result
return CompletableFuture.completedFuture(
ToolResultObject.error("Location service unavailable")
);
}
);
try (var client = new CopilotClient()) {
client.start().get();
var session = client.createSession(
new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setTools(List.of(errorTool))).get();
session.on(AssistantMessageEvent.class, msg -> {
System.out.println(msg.getData().content());
});
// Session continues even when tool fails
session.sendAndWait(new MessageOptions()
.setPrompt("What is my location? If you can't find out, just say 'unknown'."))
.get();
session.close();
}
}
}
</code></pre></section><section><a id="Best_practices"></a>
<h2>Best practices</h2>
<ol style="list-style-type: decimal;">
<li><strong>Always clean up</strong>: Use try-with-resources to ensure <code>close()</code> is called</li>
<li><strong>Handle connection errors</strong>: The CLI might not be installed or running</li>
<li><strong>Set appropriate timeouts</strong>: Use <code>get(timeout, TimeUnit)</code> for long-running requests</li>
<li><strong>Log errors</strong>: Capture error details for debugging</li>
<li><strong>Wrap operations</strong>: Consider wrapping SDK operations in methods that handle common errors</li>
<li><strong>Check error causes</strong>: Use <code>ExecutionException.getCause()</code> to get the actual error from <code>CompletableFuture</code></li>
</ol></section></section> </main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>© 2026
</p>
</div>
</div>
</footer>
</body>
</html>