Skip to content

Fix overly broad classpath scanning in ReflectUtil.getClassesWithAnnotation() #13427

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

Draft
vishesh92 wants to merge 2 commits into
base: 4.22
Choose a base branch
from
+8 −1
Draft

Fix overly broad classpath scanning in ReflectUtil.getClassesWithAnnotation() #13427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34649c8
Fix overly broad classpath scanning in ReflectUtil.getClassesWithAnno…
Apr 4, 2026
6820db8
Add missing API command packages to ApiXmlDocWriter's classpath scan …
vishesh92 Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion server/src/main/java/com/cloud/api/doc/ApiXmlDocWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@ private static List<String> setAsyncResponses() {
public static void main(String[] args) {
Set<Class<?>> cmdClasses = ReflectUtil.getClassesWithAnnotation(APICommand.class, new String[] {"org.apache.cloudstack.api", "com.cloud.api",
"com.cloud.api.commands", "com.globo.globodns.cloudstack.api", "org.apache.cloudstack.network.opendaylight.api",
"org.apache.cloudstack.api.command.admin.zone", "org.apache.cloudstack.network.contrail.api.command"});
"org.apache.cloudstack.api.command.admin.zone", "org.apache.cloudstack.network.contrail.api.command",
"org.apache.cloudstack.cloudian.api", "org.apache.cloudstack.framework.extensions.api",
"org.apache.cloudstack.mom.webhook.api.command.user", "org.apache.cloudstack.network.tungsten.api.command",
"org.apache.cloudstack.oauth2.api.command", "org.apache.cloudstack.storage.datastore.util"});
Comment on lines +95 to +98

@DaanHoogland DaanHoogland Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this going to be maintenance hog, when people add plugins?

@vishesh92 vishesh92 Jul 24, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, small change. Similar to what we do currently for ./tools/apidoc/gen_toc.py.


for (Class<?> cmdClass : cmdClasses) {
if(cmdClass.getAnnotation(APICommand.class)==null){
Expand Down
4 changes: 4 additions & 0 deletions utils/src/main/java/com/cloud/utils/ReflectUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import org.reflections.scanners.TypeAnnotationsScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;

import com.cloud.utils.exception.CloudRuntimeException;
import com.google.common.collect.ImmutableSet;
Expand Down Expand Up @@ -70,9 +71,12 @@ public static Set<Class<?>> getClassesWithAnnotation(Class<? extends Annotation>
Reflections reflections;
Set<Class<?>> classes = new HashSet<Class<?>>();
ConfigurationBuilder builder=new ConfigurationBuilder();
FilterBuilder filterBuilder = new FilterBuilder();
for (String packageName : packageNames) {
builder.addUrls(ClasspathHelper.forPackage(packageName));
filterBuilder.includePackage(packageName);
}
builder.filterInputsBy(filterBuilder);
builder.setScanners(new SubTypesScanner(),new TypeAnnotationsScanner());
reflections = new Reflections(builder);
classes.addAll(reflections.getTypesAnnotatedWith(annotation));
Expand Down
Loading