Skip to content

Commit

Permalink
[MRESOLVER-585] Explain reason for this method (#548)
Browse files Browse the repository at this point in the history
This method is NOT the "usual" way to introduce new LRM
implementation. LRM is special in a sense, is needed early.
Proper way is to integrate with LRMProvider instead and
tune priorities and/or LocalRepository type strings.

---

https://issues.apache.org/jira/browse/MRESOLVER-585
  • Loading branch information
cstamas authored Aug 2, 2024
1 parent ebb47be commit 7bfa410
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,12 @@ interface SessionBuilder {
/**
* Sets the local repository manager used during this session. <em>Note:</em> Eventually, a valid session must have
* a local repository manager set.
* <p>
* The provisioning of {@link org.eclipse.aether.repository.LocalRepositoryManager} for use with this
* method introduces chicken and egg situation. Integrators MUST NOT use this method, but instead, hook into
* Local Repository Manager Provider by any means they can (ie by using Provider or Sisu Components) and use
* custom string and/or priorities instead. This method existence is not meant for "everyday use" (normal
* session creation), but for some more advanced use cases. Do not use it, unless you know what are you doing.
*
* @param localRepositoryManager The local repository manager used during this session, may be {@code null}.
* @return This session for chaining, never {@code null}.
Expand Down

0 comments on commit 7bfa410

Please sign in to comment.