1 package org.apache.archiva.consumers.core;
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
22 import org.apache.archiva.admin.model.beans.ManagedRepository;
23 import org.apache.archiva.checksum.ChecksumAlgorithm;
24 import org.apache.archiva.checksum.ChecksummedFile;
25 import org.apache.archiva.configuration.ArchivaConfiguration;
26 import org.apache.archiva.configuration.FileTypes;
27 import org.apache.archiva.consumers.AbstractMonitoredConsumer;
28 import org.apache.archiva.consumers.ConsumerException;
29 import org.apache.archiva.consumers.KnownRepositoryContentConsumer;
30 import org.springframework.context.annotation.Scope;
31 import org.springframework.stereotype.Service;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
35 import javax.annotation.PostConstruct;
36 import javax.inject.Inject;
38 import java.io.IOException;
39 import java.util.ArrayList;
40 import java.util.Date;
41 import java.util.List;
44 * ArtifactMissingChecksumsConsumer - Create missing and/or fix invalid checksums for the artifact.
48 @Service( "knownRepositoryContentConsumer#create-missing-checksums" )
50 public class ArtifactMissingChecksumsConsumer
51 extends AbstractMonitoredConsumer
52 implements KnownRepositoryContentConsumer
53 // it's prototype bean so we assume configuration won't change during a run
57 private Logger log = LoggerFactory.getLogger( ArtifactMissingChecksumsConsumer.class );
59 private String id = "create-missing-checksums";
61 private String description = "Create Missing and/or Fix Invalid Checksums (.sha1, .md5)";
63 private ArchivaConfiguration configuration;
65 private FileTypes filetypes;
67 private ChecksummedFile checksum;
69 private static final String TYPE_CHECKSUM_NOT_FILE = "checksum-bad-not-file";
71 private static final String TYPE_CHECKSUM_CANNOT_CALC = "checksum-calc-failure";
73 private static final String TYPE_CHECKSUM_CANNOT_CREATE = "checksum-create-failure";
75 private File repositoryDir;
77 private List<String> includes = new ArrayList<>( 0 );
80 public ArtifactMissingChecksumsConsumer( ArchivaConfiguration configuration, FileTypes filetypes )
82 this.configuration = configuration;
83 this.filetypes = filetypes;
85 //configuration.addChangeListener( this );
97 public String getDescription()
99 return this.description;
103 public void beginScan( ManagedRepository repo, Date whenGathered )
104 throws ConsumerException
106 this.repositoryDir = new File( repo.getLocation() );
110 public void beginScan( ManagedRepository repo, Date whenGathered, boolean executeOnEntireRepo )
111 throws ConsumerException
113 beginScan( repo, whenGathered );
117 public void completeScan()
123 public void completeScan( boolean executeOnEntireRepo )
129 public List<String> getExcludes()
131 return getDefaultArtifactExclusions();
135 public List<String> getIncludes()
141 public void processFile( String path )
142 throws ConsumerException
144 createFixChecksum( path, new ChecksumAlgorithm[]{ ChecksumAlgorithm.SHA1 } );
145 createFixChecksum( path, new ChecksumAlgorithm[]{ ChecksumAlgorithm.MD5 } );
149 public void processFile( String path, boolean executeOnEntireRepo )
150 throws ConsumerException
155 private void createFixChecksum( String path, ChecksumAlgorithm checksumAlgorithm[] )
157 File artifactFile = new File( this.repositoryDir, path );
158 File checksumFile = new File( this.repositoryDir, path + checksumAlgorithm[0].getExt() );
160 if ( checksumFile.exists() )
162 checksum = new ChecksummedFile( artifactFile );
165 if ( !checksum.isValidChecksum( checksumAlgorithm[0] ) )
167 checksum.fixChecksums( checksumAlgorithm );
168 log.info( "Fixed checksum file {}", checksumFile.getAbsolutePath() );
169 triggerConsumerInfo( "Fixed checksum file " + checksumFile.getAbsolutePath() );
172 catch ( IOException e )
174 log.error( "Cannot calculate checksum for file {} :", checksumFile, e );
175 triggerConsumerError( TYPE_CHECKSUM_CANNOT_CALC, "Cannot calculate checksum for file " + checksumFile +
176 ": " + e.getMessage() );
179 else if ( !checksumFile.exists() )
181 checksum = new ChecksummedFile( artifactFile );
184 checksum.createChecksum( checksumAlgorithm[0] );
185 log.info( "Created missing checksum file {}", checksumFile.getAbsolutePath() );
186 triggerConsumerInfo( "Created missing checksum file " + checksumFile.getAbsolutePath() );
188 catch ( IOException e )
190 log.error( "Cannot create checksum for file {} :", checksumFile, e );
191 triggerConsumerError( TYPE_CHECKSUM_CANNOT_CREATE, "Cannot create checksum for file " + checksumFile +
192 ": " + e.getMessage() );
197 log.warn( "Checksum file {} is not a file. ", checksumFile.getAbsolutePath() );
198 triggerConsumerWarning( TYPE_CHECKSUM_NOT_FILE,
199 "Checksum file " + checksumFile.getAbsolutePath() + " is not a file." );
205 public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
207 if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
215 public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
222 private void initIncludes()
224 includes = new ArrayList<>( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
229 public void initialize()
231 //configuration.addChangeListener( this );