You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sling.apache.org by GitBox <gi...@apache.org> on 2022/01/17 09:51:47 UTC
[GitHub] [sling-org-apache-sling-api] kwin opened a new pull request #40: SLING-11067 extend URIProvider by method returning Optional
kwin opened a new pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40
Prevents throwing exception if URIProvider does not have URI for
resource. Cleanup some javadoc
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] sonarcloud[bot] commented on pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#issuecomment-1014375711
SonarCloud Quality Gate failed. 
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [2 Code Smells](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] sonarcloud[bot] removed a comment on pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] removed a comment on pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#issuecomment-1014334306
SonarCloud Quality Gate failed. 
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [2 Code Smells](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] bdelacretaz commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
bdelacretaz commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785825886
##########
File path: src/main/java/org/apache/sling/api/resource/external/URIProvider.java
##########
@@ -91,4 +85,34 @@
*/
PUBLIC
}
+
+ /**
+ * Return a URI applicable to the defined scope.
+ * @param resource the resource to convert from.
+ * @param scope the required scope.
+ * @param operation the required operation.
+ * @return a URI if the resource has a URI suitable for the requested scope and operation, otherwise the implementation should throw an {@link IllegalArgumentException}.
+ * @throws IllegalArgumentException if a URI for the requested scope and operation cannot be provided to the caller.
+ * @deprecated Use {@link #getOptionalUriForResource(Resource, Scope, Operation)} instead.
+ */
+ @Deprecated
+ @NotNull URI toURI(@NotNull Resource resource, @NotNull Scope scope, @NotNull Operation operation);
+
+ /**
+ * Return a URI applicable to the defined scope.
+ * @param resource the resource to convert from.
+ * @param scope the required scope.
+ * @param operation the required operation.
+ * @return a URI if the resource has a URI suitable for the requested scope and operation, otherwise {@link Optional#empty()}.
+ * @since 1.1.0 (Sling API Bundle 2.25.0)
+ */
+ default @NotNull Optional<URI> getOptionalUriForResource(@NotNull Resource resource, @NotNull Scope scope, @NotNull Operation operation) {
Review comment:
Unless there's a good reason to use a different name I think this should be called `toOptionalURI` based on the original `toURI` name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] kwin commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785932000
##########
File path: src/main/java/org/apache/sling/api/resource/external/package-info.java
##########
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("1.0.2")
+@Version("1.1.0")
Review comment:
What about exporting this package with two versions? Do you know which version is picked by Bnd at build time to generate the import-version-policy?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] kwin commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785932000
##########
File path: src/main/java/org/apache/sling/api/resource/external/package-info.java
##########
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("1.0.2")
+@Version("1.1.0")
Review comment:
What about exporting this package with two versions? Do you know which version is picked by Bnd at build time to generate the import-version range?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] cziegeler commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
cziegeler commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785933676
##########
File path: src/main/java/org/apache/sling/api/resource/external/package-info.java
##########
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("1.0.2")
+@Version("1.1.0")
Review comment:
I think that's too complicated - so I fear we have to increase the minor version which is really very unfortunate
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] sonarcloud[bot] commented on pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#issuecomment-1014334306
SonarCloud Quality Gate failed. 
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [2 Code Smells](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] sonarcloud[bot] commented on pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] commented on pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#issuecomment-1014352109
SonarCloud Quality Gate failed. 
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [2 Code Smells](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] kwin commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785833311
##########
File path: src/main/java/org/apache/sling/api/resource/external/URIProvider.java
##########
@@ -91,4 +85,34 @@
*/
PUBLIC
}
+
+ /**
+ * Return a URI applicable to the defined scope.
+ * @param resource the resource to convert from.
+ * @param scope the required scope.
+ * @param operation the required operation.
+ * @return a URI if the resource has a URI suitable for the requested scope and operation, otherwise the implementation should throw an {@link IllegalArgumentException}.
+ * @throws IllegalArgumentException if a URI for the requested scope and operation cannot be provided to the caller.
+ * @deprecated Use {@link #getOptionalUriForResource(Resource, Scope, Operation)} instead.
+ */
+ @Deprecated
+ @NotNull URI toURI(@NotNull Resource resource, @NotNull Scope scope, @NotNull Operation operation);
+
+ /**
+ * Return a URI applicable to the defined scope.
+ * @param resource the resource to convert from.
+ * @param scope the required scope.
+ * @param operation the required operation.
+ * @return a URI if the resource has a URI suitable for the requested scope and operation, otherwise {@link Optional#empty()}.
+ * @since 1.1.0 (Sling API Bundle 2.25.0)
+ */
+ default @NotNull Optional<URI> getOptionalUriForResource(@NotNull Resource resource, @NotNull Scope scope, @NotNull Operation operation) {
Review comment:
Done in https://github.com/apache/sling-org-apache-sling-api/pull/40/commits/68fbe450fb263201cae6ef7c3282f05a89177df7.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] kwin commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785924652
##########
File path: src/main/java/org/apache/sling/api/resource/external/package-info.java
##########
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("1.0.2")
+@Version("1.1.0")
Review comment:
Yes, but if we would only increase the patch version consumers could not depend on the new method easily due to the default import version range being used by Bnd (https://bnd.bndtools.org/chapters/170-versioning.html#import-version-policy). I want consumer bundles to no start which depend on this method, in case only 1.0.2 of this package is deployed!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] kwin commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785924652
##########
File path: src/main/java/org/apache/sling/api/resource/external/package-info.java
##########
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("1.0.2")
+@Version("1.1.0")
Review comment:
Yes, but if we would only increase the patch version consumers could not depend on the new method easily due to the default import version range being used by Bnd (https://bnd.bndtools.org/chapters/170-versioning.html#import-version-policy). I want consumer bundles to not start which depend on this method, in case only 1.0.2 of this package is deployed!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] sonarcloud[bot] removed a comment on pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
sonarcloud[bot] removed a comment on pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#issuecomment-1014352109
SonarCloud Quality Gate failed. 
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG) [0 Bugs](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=BUG)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY) [0 Vulnerabilities](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=VULNERABILITY)
[](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT) [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=SECURITY_HOTSPOT)
[](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL) [2 Code Smells](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-api&pullRequest=40&resolved=false&types=CODE_SMELL)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list) [0.0% Coverage](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_coverage&view=list)
[](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list) [0.0% Duplication](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-api&pullRequest=40&metric=new_duplicated_lines_density&view=list)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] cziegeler commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
cziegeler commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785800371
##########
File path: src/main/java/org/apache/sling/api/resource/external/ExternalizableInputStream.java
##########
@@ -22,23 +22,25 @@
import java.net.URI;
import org.jetbrains.annotations.NotNull;
+import org.osgi.annotation.versioning.ProviderType;
/**
* This interface is normally used to extend an InputStream to indicate that it has a URI form that could
* be used in place of the InputStream if desired. It is used in situations where the internal of a ResourceProvider
- * wants to offload IO to channels that do not pass through the JVM. The URI that is returned may have restrictions
+ * wants to offload I/O to channels that do not pass through the JVM. The URI that is returned may have restrictions
* imposed on it requiring it to be used immediately. Do not store the URI for later usage as it will, in most cases,
* have expired.
- *
+ * Every implementation implementing {@code ExternalizableInputStream} should rely on {@link URIProviders} for getting the URI.
+ * @since 1.0.0 (Sling API Bundle 2.16.4)
*/
+@ProviderType
Review comment:
This is a breaking change, it will break all existing bundles implementing this type
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] kwin commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
kwin commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785812082
##########
File path: src/main/java/org/apache/sling/api/resource/external/ExternalizableInputStream.java
##########
@@ -22,23 +22,25 @@
import java.net.URI;
import org.jetbrains.annotations.NotNull;
+import org.osgi.annotation.versioning.ProviderType;
/**
* This interface is normally used to extend an InputStream to indicate that it has a URI form that could
* be used in place of the InputStream if desired. It is used in situations where the internal of a ResourceProvider
- * wants to offload IO to channels that do not pass through the JVM. The URI that is returned may have restrictions
+ * wants to offload I/O to channels that do not pass through the JVM. The URI that is returned may have restrictions
* imposed on it requiring it to be used immediately. Do not store the URI for later usage as it will, in most cases,
* have expired.
- *
+ * Every implementation implementing {@code ExternalizableInputStream} should rely on {@link URIProviders} for getting the URI.
+ * @since 1.0.0 (Sling API Bundle 2.16.4)
*/
+@ProviderType
Review comment:
Thanks, reverted in https://github.com/apache/sling-org-apache-sling-api/pull/40/commits/2b8577c3630b5df17a2c6f47975427951cc03822. Still, logically only providers are supposed to implement this IMHO.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [sling-org-apache-sling-api] cziegeler commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional
Posted by GitBox <gi...@apache.org>.
cziegeler commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785918754
##########
File path: src/main/java/org/apache/sling/api/resource/external/package-info.java
##########
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("1.0.2")
+@Version("1.1.0")
Review comment:
With the minor version increase we break every URIProvider - which is not necessary as the new method has a default method
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org