AcpSyncClient

java.lang.Object
- com.agentclientprotocol.sdk.client.AcpSyncClient

所有已实现的接口:

java.lang.AutoCloseable
```
public class AcpSyncClient
extends java.lang.Object
implements java.lang.AutoCloseable
```
A synchronous client implementation for the Agent Client Protocol (ACP) that wraps an AcpAsyncClient to provide blocking operations.
This client implements the ACP specification by delegating to an asynchronous client and blocking on the results. Key features include:
- Synchronous, blocking API for simpler integration in non-reactive applications
- Initialize handshake and capability negotiation
- Session creation and management
- Prompt submission with streaming updates
- Authentication support for agents requiring it
The client follows the same lifecycle as its async counterpart:
1. Initialization - Establishes connection and negotiates protocol version
2. Authentication - Optional authentication step
3. Session Creation - Creates a new agent session with working directory
4. Prompt Interaction - Sends prompts and receives responses
5. Graceful Shutdown - Ensures clean connection termination
This implementation implements AutoCloseable for resource cleanup and provides both immediate and graceful shutdown options. All operations block until completion or timeout, making it suitable for traditional synchronous programming models.
Example usage:
```
 try (AcpSyncClient client = AcpClient.sync(transport).build()) {
     // Initialize
     AcpSchema.InitializeResponse initResponse = client.initialize(
         new AcpSchema.InitializeRequest(1, new AcpSchema.ClientCapabilities()));

     // Create session
     AcpSchema.NewSessionResponse sessionResponse = client.newSession(
         new AcpSchema.NewSessionRequest("/workspace", List.of()));

     // Send prompt
     AcpSchema.PromptResponse response = client.prompt(
         new AcpSchema.PromptRequest(sessionResponse.sessionId(),
             List.of(new AcpSchema.TextContent("Fix the bug"))));

     System.out.println("Stop reason: " + response.stopReason());
 }
 
```
另请参阅:

AcpClient, AcpAsyncClient, AcpSchema

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`AcpSchema.AuthenticateResponse`	`authenticate(AcpSchema.AuthenticateRequest authenticateRequest)` Authenticates with the agent using the specified authentication method.
`void`	`cancel(AcpSchema.CancelNotification cancelNotification)` Cancels ongoing operations for a session.
`void`	`close()` Closes the client connection and waits for shutdown to complete.
`boolean`	`closeGracefully()` Gracefully closes the client connection with a default timeout.
`NegotiatedCapabilities`	`getAgentCapabilities()` Returns the capabilities negotiated with the agent during initialization.
`AcpSchema.InitializeResponse`	`initialize()` Initializes the ACP client with default settings.
`AcpSchema.InitializeResponse`	`initialize(AcpSchema.InitializeRequest initializeRequest)` Initializes the connection with the agent.
`AcpSchema.LoadSessionResponse`	`loadSession(AcpSchema.LoadSessionRequest loadSessionRequest)` Loads an existing agent session by ID.
`AcpSchema.NewSessionResponse`	`newSession(AcpSchema.NewSessionRequest newSessionRequest)` Creates a new agent session with the specified working directory.
`AcpSchema.PromptResponse`	`prompt(AcpSchema.PromptRequest promptRequest)` Sends a prompt to the agent within a session.
`AcpSchema.SetSessionModeResponse`	`setSessionMode(AcpSchema.SetSessionModeRequest setModeRequest)` Sets the operational mode for a session (e.g., "code", "plan", "review").
`AcpSchema.SetSessionModelResponse`	`setSessionModel(AcpSchema.SetSessionModelRequest setModelRequest)` Sets the AI model for the specified session.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - close
```
public void close()
```
    Closes the client connection and waits for shutdown to complete.
    This method blocks until the connection is closed or the timeout is reached. For synchronous clients, this ensures resources are fully released when try-with-resources completes.
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
  - closeGracefully
```
public boolean closeGracefully()
```
    Gracefully closes the client connection with a default timeout.
    
    返回:
    
    true if the client closed gracefully, false if it timed out
  - initialize
```
public AcpSchema.InitializeResponse initialize(AcpSchema.InitializeRequest initializeRequest)
```
    Initializes the connection with the agent. This is the first step in the ACP lifecycle and negotiates protocol version and capabilities.
    The client sends its protocol version and capabilities, and the agent responds with its supported protocol version, authentication methods, and capabilities.
    
    参数:
    
    initializeRequest - the initialization request containing protocol version and client capabilities
    
    返回:
    
    the initialization response with agent capabilities
    
    另请参阅:
    
    AcpSchema.METHOD_INITIALIZE
  - initialize
```
public AcpSchema.InitializeResponse initialize()
```
    Initializes the ACP client with default settings.
    Uses protocol version 1 and default client capabilities. This is a convenience method for the common case where no special capabilities need to be advertised.
    
    返回:
    
    the initialization response with agent capabilities
    
    另请参阅:
    
    initialize(AcpSchema.InitializeRequest)
  - getAgentCapabilities
```
public NegotiatedCapabilities getAgentCapabilities()
```
    Returns the capabilities negotiated with the agent during initialization.
    This method returns null if initialize(com.agentclientprotocol.sdk.spec.AcpSchema.InitializeRequest) has not been called yet.
    
    返回:
    
    the negotiated agent capabilities, or null if not initialized
  - authenticate
```
public AcpSchema.AuthenticateResponse authenticate(AcpSchema.AuthenticateRequest authenticateRequest)
```
    Authenticates with the agent using the specified authentication method.
    Authentication is optional and depends on the agent's configuration. The authentication methods available are returned in the initialize response.
    
    参数:
    
    authenticateRequest - the authentication request specifying the auth method and credentials
    
    返回:
    
    the authentication response
    
    另请参阅:
    
    AcpSchema.METHOD_AUTHENTICATE
  - newSession
```
public AcpSchema.NewSessionResponse newSession(AcpSchema.NewSessionRequest newSessionRequest)
```
    Creates a new agent session with the specified working directory.
    A session represents a conversation context with the agent. All prompts within a session share the same working directory and conversation history.
    
    参数:
    
    newSessionRequest - the session creation request with working directory and initial context
    
    返回:
    
    the session response containing the session ID
    
    另请参阅:
    
    AcpSchema.METHOD_SESSION_NEW
  - loadSession
```
public AcpSchema.LoadSessionResponse loadSession(AcpSchema.LoadSessionRequest loadSessionRequest)
```
    Loads an existing agent session by ID.
    This allows resuming a previous conversation with the agent, maintaining the full history and context.
    
    参数:
    
    loadSessionRequest - the session load request with session ID
    
    返回:
    
    the load response confirming the session was loaded
    
    另请参阅:
    
    AcpSchema.METHOD_SESSION_LOAD
  - setSessionMode
```
public AcpSchema.SetSessionModeResponse setSessionMode(AcpSchema.SetSessionModeRequest setModeRequest)
```
    Sets the operational mode for a session (e.g., "code", "plan", "review").
    Different modes may change how the agent processes prompts and what capabilities it exposes.
    
    参数:
    
    setModeRequest - the set mode request with session ID and desired mode
    
    返回:
    
    the response confirming the mode change
    
    另请参阅:
    
    AcpSchema.METHOD_SESSION_SET_MODE
  - setSessionModel
```
public AcpSchema.SetSessionModelResponse setSessionModel(AcpSchema.SetSessionModelRequest setModelRequest)
```
    Sets the AI model for the specified session.
    This allows changing which AI model is used for subsequent prompts in the session.
    
    参数:
    
    setModelRequest - the set model request with session ID and desired model
    
    返回:
    
    the response confirming the model change
    
    另请参阅:
    
    AcpSchema.METHOD_SESSION_SET_MODEL
  - prompt
```
public AcpSchema.PromptResponse prompt(AcpSchema.PromptRequest promptRequest)
```
    Sends a prompt to the agent within a session.
    The prompt can contain text, images, or other content types. The agent processes the prompt and may send streaming updates via session/update notifications before returning the final response.
    
    参数:
    
    promptRequest - the prompt request with session ID and content
    
    返回:
    
    the prompt response with stop reason
    
    另请参阅:
    
    AcpSchema.METHOD_SESSION_PROMPT
  - cancel
```
public void cancel(AcpSchema.CancelNotification cancelNotification)
```
    Cancels ongoing operations for a session.
    This sends a notification to the agent to stop any in-progress work for the specified session. Note that this is a notification (fire-and-forget), not a request.
    
    参数:
    
    cancelNotification - the cancel notification with session ID and optional reason
    
    另请参阅:
    
    AcpSchema.METHOD_SESSION_CANCEL

类 AcpSyncClient

方法概要

从类继承的方法 java.lang.Object

方法详细资料

close

closeGracefully

initialize

initialize

getAgentCapabilities

authenticate

newSession

loadSession

setSessionMode

setSessionModel

prompt

cancel