Skip to content

OKAPI-1228: Add javadoc about ServicesResourceTransformer requirement #1425

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

Merged
julianladisch merged 3 commits into from
Dec 4, 2025
+9 −1
Merged

OKAPI-1228: Add javadoc about ServicesResourceTransformer requirement #1425

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26a820d
OKAPI-1228: Add javadoc about ServicesResourceTransformer requirement
julianladisch Nov 20, 2025
5024984
Fix javadoc smells
julianladisch Nov 25, 2025
19aaeb3
Merge branch 'master' into OKAPI-1228
julianladisch Dec 3, 2025
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
10 changes: 9 additions & 1 deletion okapi-common/src/main/java/org/folio/okapi/common/logging/FolioLocal.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,17 @@ public class FolioLocal implements VertxServiceProvider {
* {@code src/main/resources/META-INF/services/io.vertx.core.spi.VertxServiceProvider}
* to prevent a timing (race condition) issue:
* <a href="https://folio-org.atlassian.net/browse/OKAPI-1228">OKAPI-1228</a>.
*
* <p>If some other dependency also ships with io.vertx.core.spi.VertxServiceProvider
* add the {@code ServicesResourceTransformer} transformer to {@code maven-shade-plugin}
* so that both files get concatenated, see
* <a href="https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html#ServicesResourceTransformer">manual</a>
* and <a href="https://github.com/folio-org/mod-copycat/pull/123/files">example</a>.
*/
@Override
@SuppressWarnings("java:S2696") // Suppress "Make method static", cannot change supertype
@SuppressWarnings({"java:S2696", // Suppress "Make method static", cannot change supertype
"java:S103", // Suppress "Line too long" to keep the URL in the javadoc without breaking it
})
public void init(VertxBootstrap builder) {
initialized = true;
}
Expand Down
Loading