Skip to content

refactor: Replace Plexus AbstractLogEnabled with SLF4J #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elharo merged 2 commits into from
Nov 17, 2024
Merged

refactor: Replace Plexus AbstractLogEnabled with SLF4J #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e7af87
refactor: Replace Plexus AbstractLogEnabled with SLF4J
timtebeek Nov 16, 2024
0f7cc50
Fix checkstyle violations
timtebeek Nov 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions archetype-common/src/main/java/org/apache/maven/archetype/DefaultArchetypeManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,19 @@
import org.apache.maven.archetype.generator.ArchetypeGenerator;
import org.apache.maven.archetype.source.ArchetypeDataSource;
import org.apache.maven.archetype.source.ArchetypeDataSourceException;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.IOUtil;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* @author Jason van Zyl
*/
@Named
@Singleton
public class DefaultArchetypeManager extends AbstractLogEnabled implements ArchetypeManager {
public class DefaultArchetypeManager implements ArchetypeManager {
private static final Logger LOGGER = LoggerFactory.getLogger(DefaultArchetypeManager.class);

@Inject
@Named("fileset")
Expand Down Expand Up @@ -92,7 +94,7 @@ public void zip(File sourceDirectory, File archive) throws IOException {
}

if (!archive.exists() && !archive.createNewFile()) {
getLogger().warn("Could not create new file \"" + archive.getPath() + "\" or the file already exists.");
LOGGER.warn("Could not create new file \"" + archive.getPath() + "\" or the file already exists.");
}

try (ZipOutputStream zos = new ZipOutputStream(Files.newOutputStream(archive.toPath()))) {
Expand Down Expand Up @@ -146,10 +148,7 @@ public ArchetypeCatalog getInternalCatalog() {

return source.getArchetypeCatalog(null, null);
} catch (ArchetypeDataSourceException e) {
getLogger()
.warn(
"failed to read catalog: " + e.getMessage(),
getLogger().isDebugEnabled() ? e : null);
LOGGER.warn("failed to read catalog: " + e.getMessage(), LOGGER.isDebugEnabled() ? e : null);
return new ArchetypeCatalog();
}
}
Expand All @@ -161,10 +160,7 @@ public ArchetypeCatalog getLocalCatalog(RepositorySystemSession repositorySessio

return source.getArchetypeCatalog(repositorySession, null);
} catch (ArchetypeDataSourceException e) {
getLogger()
.warn(
"failed to read catalog: " + e.getMessage(),
getLogger().isDebugEnabled() ? e : null);
LOGGER.warn("failed to read catalog: " + e.getMessage(), LOGGER.isDebugEnabled() ? e : null);
return new ArchetypeCatalog();
}
}
Expand All @@ -177,10 +173,7 @@ public ArchetypeCatalog getRemoteCatalog(

return source.getArchetypeCatalog(repositorySession, remoteRepositories);
} catch (ArchetypeDataSourceException e) {
getLogger()
.warn(
"failed to download from remote" + e.getMessage(),
getLogger().isDebugEnabled() ? e : null);
LOGGER.warn("failed to download from remote" + e.getMessage(), LOGGER.isDebugEnabled() ? e : null);
return new ArchetypeCatalog();
}
}
Expand All @@ -192,7 +185,7 @@ public File updateLocalCatalog(RepositorySystemSession repositorySystemSession,

return source.updateCatalog(repositorySystemSession, archetype);
} catch (ArchetypeDataSourceException e) {
getLogger().warn("failed to update catalog", e);
LOGGER.warn("failed to update catalog", e);
}
return null;
}
Expand Down
40 changes: 21 additions & 19 deletions ...mmon/src/main/java/org/apache/maven/archetype/common/DefaultArchetypeArtifactManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,17 @@
import org.apache.maven.archetype.metadata.io.xpp3.ArchetypeDescriptorXpp3Reader;
import org.apache.maven.archetype.old.descriptor.ArchetypeDescriptorBuilder;
import org.apache.maven.model.Model;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Named
@Singleton
public class DefaultArchetypeArtifactManager extends AbstractLogEnabled implements ArchetypeArtifactManager {
public class DefaultArchetypeArtifactManager implements ArchetypeArtifactManager {
private static final Logger LOGGER = LoggerFactory.getLogger(DefaultArchetypeArtifactManager.class);

@Inject
private Downloader downloader;

Expand Down Expand Up @@ -138,24 +141,24 @@ public ZipFile getArchetypeZipFile(File archetypeFile) throws UnknownArchetype {

@Override
public boolean isFileSetArchetype(File archetypeFile) {
getLogger().debug("checking fileset archetype status on " + archetypeFile);
LOGGER.debug("checking fileset archetype status on " + archetypeFile);

try (ZipFile zipFile = getArchetypeZipFile(archetypeFile)) {
return isFileSetArchetype(zipFile);
} catch (IOException | UnknownArchetype e) {
getLogger().debug(e.toString());
LOGGER.debug(e.toString());
return false;
}
}

@Override
public boolean isOldArchetype(File archetypeFile) {
getLogger().debug("checking old archetype status on " + archetypeFile);
LOGGER.debug("checking old archetype status on " + archetypeFile);

try (ZipFile zipFile = getArchetypeZipFile(archetypeFile)) {
return isOldArchetype(zipFile);
} catch (IOException | UnknownArchetype e) {
getLogger().debug(e.toString());
LOGGER.debug(e.toString());
return false;
}
}
Expand All @@ -181,11 +184,10 @@ public boolean exists(

return archetype.exists();
} catch (DownloadException e) {
getLogger()
.debug(
"Archetype " + archetypeGroupId + ":" + archetypeArtifactId + ":" + archetypeVersion
+ " doesn't exist",
e);
LOGGER.debug(
"Archetype " + archetypeGroupId + ":" + archetypeArtifactId + ":" + archetypeVersion
+ " doesn't exist",
e);
return false;
}
}
Expand All @@ -211,7 +213,7 @@ public ArchetypeDescriptor getFileSetArchetypeDescriptor(File archetypeFile) thr

@Override
public List<String> getFilesetArchetypeResources(File archetypeFile) throws UnknownArchetype {
getLogger().debug("getFilesetArchetypeResources( \"" + archetypeFile.getAbsolutePath() + "\" )");
LOGGER.debug("getFilesetArchetypeResources( \"" + archetypeFile.getAbsolutePath() + "\" )");
List<String> archetypeResources = new ArrayList<>();

try (ZipFile zipFile = getArchetypeZipFile(archetypeFile)) {
Expand All @@ -222,11 +224,11 @@ public List<String> getFilesetArchetypeResources(File archetypeFile) throws Unkn
if (entry.getName().startsWith(Constants.ARCHETYPE_RESOURCES)) {
// not supposed to be file.separator
String resource = entry.getName().substring(Constants.ARCHETYPE_RESOURCES.length() + 1);
getLogger().debug(" - found resource (" + Constants.ARCHETYPE_RESOURCES + "/)" + resource);
LOGGER.debug(" - found resource (" + Constants.ARCHETYPE_RESOURCES + "/)" + resource);
// TODO:FIXME
archetypeResources.add(resource);
} else {
getLogger().debug(" - ignored resource " + entry.getName());
LOGGER.debug(" - ignored resource " + entry.getName());
}
}
return archetypeResources;
Expand All @@ -249,12 +251,12 @@ private File getArchetype(String archetypeGroupId, String archetypeArtifactId, S
String key = archetypeGroupId + ":" + archetypeArtifactId + ":" + archetypeVersion;

if (archetypeCache.containsKey(key)) {
getLogger().debug("Found archetype " + key + " in cache: " + archetypeCache.get(key));
LOGGER.debug("Found archetype " + key + " in cache: " + archetypeCache.get(key));

return archetypeCache.get(key);
}

getLogger().debug("Not found archetype " + key + " in cache");
LOGGER.debug("Not found archetype " + key + " in cache");
return null;
}

Expand Down Expand Up @@ -335,15 +337,15 @@ private Reader getDescriptorReader(ZipFile zipFile, String descriptor) throws IO
}

private ZipEntry searchEntry(ZipFile zipFile, String searchString) {
getLogger().debug("Searching for " + searchString + " inside " + zipFile.getName());
LOGGER.debug("Searching for " + searchString + " inside " + zipFile.getName());

Enumeration<? extends ZipEntry> enu = zipFile.entries();
while (enu.hasMoreElements()) {
ZipEntry entryfound = enu.nextElement();
getLogger().debug(" - " + entryfound.getName());
LOGGER.debug(" - " + entryfound.getName());

if (searchString.equals(entryfound.getName())) {
getLogger().debug("Entry found");
LOGGER.debug("Entry found");
return entryfound;
}
}
Expand Down
40 changes: 20 additions & 20 deletions ...common/src/main/java/org/apache/maven/archetype/common/DefaultArchetypeFilesResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,16 @@
import org.apache.maven.archetype.common.util.ListScanner;
import org.apache.maven.archetype.common.util.PathUtils;
import org.apache.maven.archetype.metadata.FileSet;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Named
@Singleton
public class DefaultArchetypeFilesResolver extends AbstractLogEnabled implements ArchetypeFilesResolver {
public class DefaultArchetypeFilesResolver implements ArchetypeFilesResolver {
private static final Logger LOGGER = LoggerFactory.getLogger(DefaultArchetypeFilesResolver.class);

@Override
public List<String> getFilesWithExtension(List<String> files, String extension) {
ListScanner scanner = new ListScanner();
Expand All @@ -58,7 +61,7 @@ public List<String> getFilteredFiles(List<String> files, String filtered) {
scanner.setExcludes("");

List<String> result = scanner.scan(files);
getLogger().debug("Scanned " + result.size() + " filtered files in " + files.size() + " files");
LOGGER.debug("Scanned " + result.size() + " filtered files in " + files.size() + " files");

return result;
}
Expand Down Expand Up @@ -91,8 +94,7 @@ public List<String> findOtherResources(int level, List<String> files, String lan
scanner.setExcludes(languages);

List<String> result = scanner.scan(files);
getLogger()
.debug("Scanned " + result.size() + " other resources in " + files.size() + " files at level " + level);
LOGGER.debug("Scanned " + result.size() + " other resources in " + files.size() + " files at level " + level);

return result;
}
Expand All @@ -119,8 +121,7 @@ public List<String> findOtherResources(int level, List<String> files, List<Strin
scanner.setExcludes(languages);

List<String> result = scanner.scan(files);
getLogger()
.debug("Scanned " + result.size() + " other resources in " + files.size() + " files at level " + level);
LOGGER.debug("Scanned " + result.size() + " other resources in " + files.size() + " files at level " + level);

return result;
}
Expand All @@ -144,8 +145,7 @@ public List<String> findOtherSources(int level, List<String> files, String langu
scanner.setIncludes(includes.toString());

List<String> result = scanner.scan(files);
getLogger()
.debug("Scanned " + result.size() + " other sources in " + files.size() + " files at level " + level);
LOGGER.debug("Scanned " + result.size() + " other sources in " + files.size() + " files at level " + level);

return result;
}
Expand All @@ -159,7 +159,7 @@ public List<String> findResourcesMainFiles(List<String> files, String languages)
scanner.setExcludes(languages);

List<String> result = scanner.scan(files);
getLogger().debug("Scanned " + result.size() + " resources in " + files.size() + " files");
LOGGER.debug("Scanned " + result.size() + " resources in " + files.size() + " files");

return result;
}
Expand All @@ -173,7 +173,7 @@ public List<String> findResourcesTestFiles(List<String> files, String languages)
scanner.setExcludes(languages);

List<String> result = scanner.scan(files);
getLogger().debug("Scanned " + result.size() + " test resources in " + files.size() + " files");
LOGGER.debug("Scanned " + result.size() + " test resources in " + files.size() + " files");

return result;
}
Expand All @@ -187,7 +187,7 @@ public List<String> findSiteFiles(List<String> files, String languages) {
scanner.setExcludes(languages);

List<String> result = scanner.scan(files);
getLogger().debug("Scanned " + result.size() + " site resources in " + files.size() + " files");
LOGGER.debug("Scanned " + result.size() + " site resources in " + files.size() + " files");

return result;
}
Expand All @@ -200,7 +200,7 @@ public List<String> findSourcesMainFiles(List<String> files, String languages) {
scanner.setIncludes(languages);

List<String> result = scanner.scan(files);
getLogger().debug("Scanned " + result.size() + " sources in " + files.size() + " files");
LOGGER.debug("Scanned " + result.size() + " sources in " + files.size() + " files");

return result;
}
Expand All @@ -213,7 +213,7 @@ public List<String> findSourcesTestFiles(List<String> files, String languages) {
scanner.setIncludes(languages);

List<String> result = scanner.scan(files);
getLogger().debug("Scanned " + result.size() + " test sources in " + files.size() + " files");
LOGGER.debug("Scanned " + result.size() + " test sources in " + files.size() + " files");

return result;
}
Expand All @@ -226,13 +226,13 @@ public List<String> getPackagedFiles(List<String> files, String packageName) {
packagedFiles.add(file.substring(packageName.length() + 1));
}
}
getLogger().debug("Scanned " + packagedFiles.size() + " packaged files in " + files.size() + " files");
LOGGER.debug("Scanned " + packagedFiles.size() + " packaged files in " + files.size() + " files");
return packagedFiles;
}

@Override
public String resolvePackage(File basedir, List<String> languages) throws IOException {
getLogger().debug("Resolving package in " + basedir + " using languages " + languages);
LOGGER.debug("Resolving package in " + basedir + " using languages " + languages);

List<String> files = resolveFiles(basedir, languages);

Expand All @@ -247,7 +247,7 @@ public List<String> getUnpackagedFiles(List<String> files, String packageName) {
unpackagedFiles.add(file);
}
}
getLogger().debug("Scanned " + unpackagedFiles.size() + " unpackaged files in " + files.size() + " files");
LOGGER.debug("Scanned " + unpackagedFiles.size() + " unpackaged files in " + files.size() + " files");
return unpackagedFiles;
}

Expand Down Expand Up @@ -283,7 +283,7 @@ private List<String> resolveFiles(File basedir, List<String> languages) throws I

List<File> absoluteFiles = FileUtils.getFiles(basedir, StringUtils.join(languagesPathesArray, ","), excludes);

getLogger().debug("Found " + absoluteFiles.size() + " potential archetype files");
LOGGER.debug("Found " + absoluteFiles.size() + " potential archetype files");

List<String> files = new ArrayList<>(absoluteFiles.size());

Expand All @@ -303,7 +303,7 @@ private List<String> resolveFiles(File basedir, List<String> languages) throws I
}
}

getLogger().debug("Found " + files.size() + " archetype files for package resolution ");
LOGGER.debug("Found " + files.size() + " archetype files for package resolution ");

return files;
}
Expand All @@ -325,7 +325,7 @@ private String resolvePackage(List<String> files) {
}
}

getLogger().debug("Package resolved to " + packageName);
LOGGER.debug("Package resolved to " + packageName);

return packageName;
}
Expand Down
Loading