Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
cstamas merged PR #1359: URL: https://github.com/apache/maven/pull/1359 -- 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: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
cstamas commented on code in PR #1359:
URL: https://github.com/apache/maven/pull/1359#discussion_r1433042768
##
maven-core/src/main/java/org/apache/maven/internal/impl/DefaultChecksumAlgorithmService.java:
##
@@ -0,0 +1,201 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.internal.impl;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.util.*;
+import java.util.stream.Collectors;
+
+import org.apache.maven.api.services.*;
+import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory;
+import
org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactorySelector;
+import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmHelper;
+
+import static org.apache.maven.internal.impl.Utils.nonNull;
+
+@Named
+@Singleton
+public class DefaultChecksumAlgorithmService implements
ChecksumAlgorithmService {
+private final ChecksumAlgorithmFactorySelector
checksumAlgorithmFactorySelector;
+
+@Inject
+public DefaultChecksumAlgorithmService(ChecksumAlgorithmFactorySelector
checksumAlgorithmFactorySelector) {
+this.checksumAlgorithmFactorySelector =
+nonNull(checksumAlgorithmFactorySelector,
"checksumAlgorithmFactorySelector");
+}
+
+@Override
+public ChecksumAlgorithm select(String algorithmName) {
+nonNull(algorithmName, "algorithmName");
+return new
DefaultChecksumAlgorithm(checksumAlgorithmFactorySelector.select(algorithmName));
Review Comment:
checksumAlgorithmFactorySelector throws IllegalArgumentEx, as documented
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
gnodet commented on code in PR #1359:
URL: https://github.com/apache/maven/pull/1359#discussion_r1433034653
##
maven-core/src/main/java/org/apache/maven/internal/impl/DefaultChecksumAlgorithmService.java:
##
@@ -0,0 +1,201 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.internal.impl;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.util.*;
+import java.util.stream.Collectors;
+
+import org.apache.maven.api.services.*;
+import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory;
+import
org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactorySelector;
+import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmHelper;
+
+import static org.apache.maven.internal.impl.Utils.nonNull;
+
+@Named
+@Singleton
+public class DefaultChecksumAlgorithmService implements
ChecksumAlgorithmService {
+private final ChecksumAlgorithmFactorySelector
checksumAlgorithmFactorySelector;
+
+@Inject
+public DefaultChecksumAlgorithmService(ChecksumAlgorithmFactorySelector
checksumAlgorithmFactorySelector) {
+this.checksumAlgorithmFactorySelector =
+nonNull(checksumAlgorithmFactorySelector,
"checksumAlgorithmFactorySelector");
+}
+
+@Override
+public ChecksumAlgorithm select(String algorithmName) {
+nonNull(algorithmName, "algorithmName");
+return new
DefaultChecksumAlgorithm(checksumAlgorithmFactorySelector.select(algorithmName));
Review Comment:
What if the algorithm is not found ?
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
gnodet commented on code in PR #1359:
URL: https://github.com/apache/maven/pull/1359#discussion_r1432965303
##
api/maven-api-core/src/main/java/org/apache/maven/api/services/ChecksumAlgorithmService.java:
##
@@ -0,0 +1,160 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.api.services;
+
+import java.io.*;
+import java.nio.ByteBuffer;
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.Map;
+
+import org.apache.maven.api.Service;
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+
+/**
+ * Checksum algorithms service.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+public interface ChecksumAlgorithmService extends Service {
+/**
+ * Returns {@link ChecksumAlgorithm} for given algorithm name, or throws
if algorithm not supported.
+ *
+ * @throws IllegalArgumentException if asked algorithm name is not
supported.
+ */
+@Nonnull
+ChecksumAlgorithm select(@Nonnull String algorithmName);
+
+/**
+ * Returns a collection of {@link ChecksumAlgorithm} in same order as
algorithm names are ordered, or throws if
+ * any of the algorithm name is not supported. The returned collection has
equal count of elements as passed in
+ * collection of names, and if names contains duplicated elements, the
returned list of algorithms will have
+ * duplicates as well.
+ *
+ * @throws IllegalArgumentException if any asked algorithm name is not
supported.
+ * @throws NullPointerException if passed in list of names is {@code null}.
+ */
+@Nonnull
+Collection selectCollection(@Nonnull Collection
algorithmNames);
Review Comment:
Would `select` be sufficient for the method 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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
gnodet commented on code in PR #1359:
URL: https://github.com/apache/maven/pull/1359#discussion_r1432954888
##
api/maven-api-core/src/main/java/org/apache/maven/api/services/ChecksumAlgorithmService.java:
##
@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.api.services;
+
+import java.io.*;
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.Map;
+
+import org.apache.maven.api.Service;
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+
+/**
+ * Checksum algorithms service.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+public interface ChecksumAlgorithmService extends Service {
+/**
+ * Returns {@link ChecksumAlgorithm} for given algorithm name, or throws
if algorithm not supported.
+ *
+ * @throws IllegalArgumentException if asked algorithm name is not
supported.
+ */
+@Nonnull
+ChecksumAlgorithm select(@Nonnull String algorithmName);
+
+/**
+ * Returns a list of {@link ChecksumAlgorithm} in same order as algorithm
names are ordered, or throws if any of the
+ * algorithm name is not supported. The returned list has equal count of
elements as passed in collection of names,
+ * and if names contains duplicated elements, the returned list of
algorithms will have duplicates as well.
+ *
+ * @throws IllegalArgumentException if any asked algorithm name is not
supported.
+ * @throws NullPointerException if passed in list of names is {@code null}.
+ */
+@Nonnull
+Collection selectList(@Nonnull Collection
algorithmNames);
+
+/**
+ * Returns immutable collection of all supported algorithm names.
+ */
+@Nonnull
+Collection getChecksumAlgorithmNames();
+
+/**
+ * Calculates checksums for specified data.
+ *
+ * @param dataThe content for which to calculate checksums, must
not be {@code null}.
+ * @param algorithms The checksum algorithm factories to use, must not be
{@code null}.
+ * @return The calculated checksums, indexed by algorithm name, or the
exception that occurred while trying to
+ * calculate it, never {@code null}.
+ * @throws IOException In case of any problem.
+ */
+@Nonnull
+Map calculate(@Nonnull byte[] data, @Nonnull
Collection algorithms)
Review Comment:
The returned Map is not really useful. It should be
Map`
##
api/maven-api-core/src/main/java/org/apache/maven/api/services/ChecksumAlgorithmService.java:
##
@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.api.services;
+
+import java.io.*;
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.Map;
+
+import org.apache.maven.api.Service;
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+
+/**
+ * Checksum algorithms service.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+public interface ChecksumAlgorithmService extends Service {
+/**
+ * Returns {@link ChecksumAlgorithm} for given algorithm name, or throws
if algorithm not supported.
+ *
+ * @throws IllegalArgumentException if asked algorithm name is not
supported.
+ */
+@Nonnull
+ChecksumAlgorithm select(@Nonnull String algorithmName);
+
+/**
+ * Returns a list of {@link ChecksumAlgorithm} in same order as algorit
Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
gnodet commented on code in PR #1359:
URL: https://github.com/apache/maven/pull/1359#discussion_r1432953322
##
api/maven-api-core/src/main/java/org/apache/maven/api/services/ChecksumAlgorithmService.java:
##
@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.api.services;
+
+import java.io.*;
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.Map;
+
+import org.apache.maven.api.Service;
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+
+/**
+ * Checksum algorithms service.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+public interface ChecksumAlgorithmService extends Service {
+/**
+ * Returns {@link ChecksumAlgorithm} for given algorithm name, or throws
if algorithm not supported.
+ *
+ * @throws IllegalArgumentException if asked algorithm name is not
supported.
+ */
+@Nonnull
+ChecksumAlgorithm select(@Nonnull String algorithmName);
+
+/**
+ * Returns a list of {@link ChecksumAlgorithm} in same order as algorithm
names are ordered, or throws if any of the
+ * algorithm name is not supported. The returned list has equal count of
elements as passed in collection of names,
+ * and if names contains duplicated elements, the returned list of
algorithms will have duplicates as well.
+ *
+ * @throws IllegalArgumentException if any asked algorithm name is not
supported.
+ * @throws NullPointerException if passed in list of names is {@code null}.
+ */
+@Nonnull
+Collection selectList(@Nonnull Collection
algorithmNames);
Review Comment:
the doc and name should be adjusted to the list -> collection change in the
return 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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] [MNG-7957] Checksum API (backed by Resolver) [maven]
gnodet commented on code in PR #1359:
URL: https://github.com/apache/maven/pull/1359#discussion_r1432952929
##
api/maven-api-core/src/main/java/org/apache/maven/api/services/ChecksumAlgorithmService.java:
##
@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.api.services;
+
+import java.io.*;
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.Map;
+
+import org.apache.maven.api.Service;
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.annotations.Nonnull;
+
+/**
+ * Checksum algorithms service.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+public interface ChecksumAlgorithmService extends Service {
+/**
+ * Returns {@link ChecksumAlgorithm} for given algorithm name, or throws
if algorithm not supported.
+ *
+ * @throws IllegalArgumentException if asked algorithm name is not
supported.
+ */
+@Nonnull
+ChecksumAlgorithm select(@Nonnull String algorithmName);
+
+/**
+ * Returns a list of {@link ChecksumAlgorithm} in same order as algorithm
names are ordered, or throws if any of the
+ * algorithm name is not supported. The returned list has equal count of
elements as passed in collection of names,
+ * and if names contains duplicated elements, the returned list of
algorithms will have duplicates as well.
+ *
+ * @throws IllegalArgumentException if any asked algorithm name is not
supported.
+ * @throws NullPointerException if passed in list of names is {@code null}.
+ */
+@Nonnull
+Collection selectList(@Nonnull Collection
algorithmNames);
+
+/**
+ * Returns immutable collection of all supported algorithm names.
+ */
+@Nonnull
+Collection getChecksumAlgorithmNames();
+
+/**
+ * Calculates checksums for specified data.
+ *
+ * @param dataThe content for which to calculate checksums, must
not be {@code null}.
+ * @param algorithms The checksum algorithm factories to use, must not be
{@code null}.
+ * @return The calculated checksums, indexed by algorithm name, or the
exception that occurred while trying to
+ * calculate it, never {@code null}.
+ * @throws IOException In case of any problem.
+ */
+@Nonnull
+Map calculate(@Nonnull byte[] data, @Nonnull
Collection algorithms)
+throws IOException;
+
+/**
+ * Calculates checksums for specified file.
+ *
+ * @param fileThe file for which to calculate checksums, must not
be {@code null}.
+ * @param algorithms The checksum algorithm factories to use, must not be
{@code null}.
+ * @return The calculated checksums, indexed by algorithm name, or the
exception that occurred while trying to
+ * calculate it, never {@code null}.
+ * @throws IOException In case of any problem.
+ */
+@Nonnull
+Map calculate(@Nonnull Path file, @Nonnull
Collection algorithms)
Review Comment:
For ease of use ,we're missing `calculate(InputStream,
Collection)` 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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
