com.googlecode.download.maven.plugin.internal.checksum.Checksums Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of download-maven-plugin Show documentation

This is a plugin meant to help maven user to download different files on different protocol in part of maven build. For the first implementation, there will only be a goal that will help downloading a maven artifact from the command line. Future version of the plugin could include web download, ftp download, scp download and so on.

There is a newer version: 1.9.0

Show newest version

/*
 * Copyright 2012, Red Hat Inc.
 *
 * Licensed 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 com.googlecode.download.maven.plugin.internal.checksum;

import com.googlecode.download.maven.plugin.internal.ChecksumUtils;
import java.io.File;
import java.security.MessageDigest;
import java.util.EnumMap;
import java.util.Map;
import javax.annotation.Nullable;
import org.apache.maven.plugin.logging.Log;

/**
 * Checksums supplied to verify file integrity.
 * @author Paul Polishchuk
 */
public final class Checksums {

    private final Map supplied;

    public Checksums(
        @Nullable final String md5, @Nullable final String sha1,
        @Nullable final String sha256, @Nullable final String sha512,
        Log log
    ) {
        this.supplied = Checksums.create(md5, sha1, sha256, sha512);
        if (this.supplied.isEmpty()) {
            log.debug("No checksums were supplied, skipping file validation");
        } else if (this.supplied.size() > 1) {
            log.warn("More than one checksum is supplied. This may be slow for big files. Consider using a single checksum.");
        }
    }

    /**
     * Validates the file with supplied checksums.
     * @param file File to validate.
     * @return True if the file matches all supplied checksums
     *  or if no checksums were supplied.
     */
    public boolean isValid(final File file) {
        boolean valid = true;
        try {
            this.validate(file);
        } catch (final Exception ex) {
            valid = false;
        }
        return valid;
    }

    /**
     * Validates the file with supplied checksums.
     * @param file File to validate.
     * @throws Exception If the file didn't match any supplied checksum.
     */
    public void validate(final File file) throws Exception {
        for (final Map.Entry entry : this.supplied.entrySet()) {
            ChecksumUtils.verifyChecksum(
                file, entry.getValue(),
                MessageDigest.getInstance(entry.getKey().algo())
            );
        }
    }

    /**
     * Fill the map of checksums.
     * @param md5 Supplied md5 checksum, may be {@literal null}.
     * @param sha1 Supplied sha1 checksum, may be {@literal null}.
     * @param sha256 Supplied sha256 checksum, may be {@literal null}.
     * @param sha512 Supplied sha512 checksum, may be {@literal null}.
     * @return A map of a checksum type to a digest; {@literal null} digests
     *  are not included.
     */
    private static Map create(
        @Nullable final String md5, @Nullable final String sha1,
        @Nullable final String sha256, @Nullable final String sha512
    ) {
        final Map digests = new EnumMap<>(Checksum.class);
        if (md5 != null) {
            digests.put(Checksum.MD5, md5);
        }
        if (sha1 != null) {
            digests.put(Checksum.SHA1, sha1);
        }
        if (sha256 != null) {
            digests.put(Checksum.SHA256, sha256);
        }
        if (sha512 != null) {
            digests.put(Checksum.SHA512, sha512);
        }
        return digests;
    }
}