Class AhpHostOptions

java.lang.Object

com.github.copilot.AhpHostOptions

@CopilotExperimental
public final class AhpHostOptions
extends Object

Options for in-process AHP hosting. Select at least one transport explicitly; no local listener is started by default. Factories must return the exact session registered on the owning client with the requested identity and settings. Release callbacks end a participation, not the application's session lifetime.

Constructor Summary

Constructors

Constructor	Description
AhpHostOptions()	Creates options without a transport.

Method Summary

Modifier and Type	Method	Description
String	getComputeId()	Gets the durable catalog's compute identity.
Function<AhpSessionCreateRequest, CompletableFuture<CopilotSession>>	getCreateSession()	Gets the creation callback.
HostGitHubEnvironmentOptions	getGithubEnvironment()	Gets the GitHub Mission Control transport settings.
HostLocalServerOptions	getLocalServer()	Gets the local WebSocket transport settings.
Function<AhpHostExit, CompletableFuture<Void>>	getOnExit()	Gets the exit callback.
Function<CopilotSession, CompletableFuture<Void>>	getOnSessionReleased()	Gets the release callback.
Function<AhpSessionResumeRequest, CompletableFuture<CopilotSession>>	getResumeSession()	Gets the resume callback.
AhpHostOptions	setComputeId(String computeId)	Selects the same durable catalog for local and Mission Control hosting.
AhpHostOptions	setCreateSession(Function<AhpSessionCreateRequest, CompletableFuture<CopilotSession>> callback)	Sets the application creation callback.
AhpHostOptions	setGithubEnvironment(HostGitHubEnvironmentOptions githubEnvironment)	Enables or disables GitHub Mission Control hosting.
AhpHostOptions	setLocalServer(HostLocalServerOptions localServer)	Enables or disables the local WebSocket transport.
AhpHostOptions	setOnExit(Function<AhpHostExit, CompletableFuture<Void>> callback)	Sets the listener exit callback.
AhpHostOptions	setOnSessionReleased(Function<CopilotSession, CompletableFuture<Void>> callback)	Sets the participation-release callback.
AhpHostOptions	setResumeSession(Function<AhpSessionResumeRequest, CompletableFuture<CopilotSession>> callback)	Sets the application resume callback.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AhpHostOptions

public AhpHostOptions()

Creates options without a transport. Set a local server, a GitHub environment, or both before starting the host.

Method Details

getComputeId

public String getComputeId()

Gets the durable catalog's compute identity.

Returns:

the stable compute identity, or null for the runtime default

setComputeId

public AhpHostOptions setComputeId(String computeId)

Selects the same durable catalog for local and Mission Control hosting. Must agree with the GitHub environment's compute identity when both are supplied.

Parameters:

computeId - stable identity, or null for the runtime default

Returns:

these options

getLocalServer

public HostLocalServerOptions getLocalServer()

Gets the local WebSocket transport settings.

Returns:

the settings, or null when local hosting is disabled

setLocalServer

public AhpHostOptions setLocalServer(HostLocalServerOptions localServer)

Enables or disables the local WebSocket transport.

Parameters:

localServer - local settings, or null to disable local hosting

Returns:

these options

getGithubEnvironment

public HostGitHubEnvironmentOptions getGithubEnvironment()

Gets the GitHub Mission Control transport settings.

Returns:

the settings, or null when GitHub hosting is disabled

setGithubEnvironment

public AhpHostOptions setGithubEnvironment(HostGitHubEnvironmentOptions githubEnvironment)

Enables or disables GitHub Mission Control hosting.

Parameters:

githubEnvironment - settings with a required name and compute ID, or null

Returns:

these options

getCreateSession

public Function<AhpSessionCreateRequest, CompletableFuture<CopilotSession>> getCreateSession()

Gets the creation callback.

Returns:

the application creation callback, or null

setCreateSession

public AhpHostOptions setCreateSession(Function<AhpSessionCreateRequest, CompletableFuture<CopilotSession>> callback)

Sets the application creation callback.

Parameters:

callback - application creation callback

Returns:

these options

getResumeSession

public Function<AhpSessionResumeRequest, CompletableFuture<CopilotSession>> getResumeSession()

Gets the resume callback.

Returns:

the application resume callback, or null

setResumeSession

public AhpHostOptions setResumeSession(Function<AhpSessionResumeRequest, CompletableFuture<CopilotSession>> callback)

Sets the application resume callback.

Parameters:

callback - application resume callback

Returns:

these options

getOnSessionReleased

public Function<CopilotSession, CompletableFuture<Void>> getOnSessionReleased()

Gets the release callback.

Returns:

the participation-release callback, or null

setOnSessionReleased

public AhpHostOptions setOnSessionReleased(Function<CopilotSession, CompletableFuture<Void>> callback)

Sets the participation-release callback.

Parameters:

callback - callback receiving the exact factory result once

Returns:

these options

getOnExit

public Function<AhpHostExit, CompletableFuture<Void>> getOnExit()

Gets the exit callback.

Returns:

the listener exit callback, or null

setOnExit

public AhpHostOptions setOnExit(Function<AhpHostExit, CompletableFuture<Void>> callback)

Sets the listener exit callback.

Parameters:

callback - callback receiving the listener's final outcome once

Returns:

these options