Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Describe how exceptions of Xenon library are mapped to grpc statuses #31

Open
sverhoeven opened this issue Nov 23, 2017 · 1 comment
Open

Describe how exceptions of Xenon library are mapped to grpc statuses #31

sverhoeven opened this issue Nov 23, 2017 · 1 comment

Comments

@sverhoeven
Copy link
Member

The mapException method at https://github.com/NLeSC/xenon-grpc/blob/master/src/main/java/nl/esciencecenter/xenon/grpc/MapUtils.java#L250-L284 implements the mapping, but a developer working on a client should not have to look at the code.

The mapping should be described in Markdown, proto or javadoc.
@sverhoeven sverhoeven changed the title Describe how exception in Xenon library are mapped to grpc status Describe how exceptions of Xenon library are mapped to grpc statuses Nov 23, 2017
@sverhoeven
Copy link
Member Author

sverhoeven commented Nov 23, 2017 •
edited
Loading

Decided to add in proto file in comment of each method add:

@throws StatusCode fooException

For example

@throws NOT_FOUND NoSuchPathException
@throws INTERNAL XenonException

sverhoeven added a commit that referenced this issue Jun 14, 2019
@sverhoeven
Started describing exception mapping in proto file
ce75e94 
Refs #31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sverhoeven