-
Notifications
You must be signed in to change notification settings - Fork 2
Add MethodExtension to ServiceImplInstance
#46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Quinn-With-Two-Ns
wants to merge
1
commit into
nexus-rpc:main
Choose a base branch
from
Quinn-With-Two-Ns:NEXUS-415
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
52 changes: 52 additions & 0 deletions
52
nexus-sdk/src/main/java/io/nexusrpc/handler/MethodExtension.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| package io.nexusrpc.handler; | ||
|
|
||
| import io.nexusrpc.ServiceDefinition; | ||
| import java.lang.reflect.Method; | ||
| import java.util.Objects; | ||
| import org.jspecify.annotations.Nullable; | ||
|
|
||
| /** | ||
| * Extension point for {@link ServiceImplInstance#fromInstance(Object, java.util.List)} that lets a | ||
| * framework recognize its own operation-handler annotation alongside {@link OperationImpl}. | ||
| * | ||
| * <p>For each method discovered during scanning of a {@link ServiceImpl}-annotated class, the | ||
| * extension's {@link #extract} is called once. If the method belongs to the extension's annotation, | ||
| * the extension returns a {@link Result} describing the operation name and handler; otherwise it | ||
| * returns {@code null}. Duplicate operation registrations (across both {@link OperationImpl} and | ||
| * any extension) are caught by the builder. | ||
| * | ||
| * <p>Extensions are responsible for their own validation of method shape (parameter types, return | ||
| * type, modifiers) and for translating the method into an {@link OperationHandler}. | ||
| */ | ||
| public interface MethodExtension { | ||
|
|
||
| /** | ||
| * Inspect {@code method} on {@code instance}. Return a {@link Result} to register an operation | ||
| * handler, or {@code null} if the method is not claimed by this extension. | ||
| * | ||
| * @param instance the service implementation instance | ||
| * @param method the method being scanned | ||
| * @param serviceDefinition the resolved service definition for the {@code @ServiceImpl} | ||
| * @return a result describing the operation, or {@code null} to skip | ||
| */ | ||
| @Nullable Result extract(Object instance, Method method, ServiceDefinition serviceDefinition); | ||
|
|
||
| /** Result returned by an extension that claims a method. */ | ||
| final class Result { | ||
| private final String operationName; | ||
| private final OperationHandler<?, ?> handler; | ||
|
|
||
| public Result(String operationName, OperationHandler<?, ?> handler) { | ||
| this.operationName = Objects.requireNonNull(operationName, "operationName"); | ||
| this.handler = Objects.requireNonNull(handler, "handler"); | ||
| } | ||
|
|
||
| public String getOperationName() { | ||
| return operationName; | ||
| } | ||
|
|
||
| public OperationHandler<?, ?> getHandler() { | ||
| return handler; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's mark this as experimental. We should do this for all of the non final APIs like the ServiceImpl.