jakartaee / jakartaee/authentication

AuthConfigFactory javadoc indicates methods throw AuthException but method signatures do not

Open
#2 4 comments 0 reactions 2 assignees Claimed by @arjantijms View on GitHub
ERR: Assignee Priority: Major Type: Bug
Dominant language
Java
Stars
27
Forks
34
PR merge metrics
No merged PRs in 30d

Description

avadoc of four AuthConfigFactory methods indicate that they throw
AuthException (which is a checked exception) but method signatures do not
declare that they throw AuthException, and thus the exception cannot be thrown.
Moreover, the inability to throw this exception, makes it unclear how errors
are to be signaled by these methods.

public static AuthConfigFactory getFactory();

public abstract java.lang.StringregisterConfigProvider(
java.lang.String className,
java.util.Map properties,
java.lang.String layer,
java.lang.String appContext,
java.lang.String description);

public abstract java.lang.String registerConfigProvider(
AuthConfigProvider provider,
java.lang.String layer,
java.lang.String appContext,
java.lang.String description)

public abstract void refresh()

javadoc if refresh method of AuthConfig interface also indicates that it throws
AuthException although method signature does not declare that it does.

javadoc if refresh method of AuthConfigProvider interface also indicates that
it throws AuthException although method signature does not declare that it
does.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.