Skip to content

Commit 8380d41

Browse files
netwolfuknetwolfuk
committed
Add some doc, remove some unused ode.
1 parent 5e10d55 commit 8380d41

14 files changed

Lines changed: 77 additions & 286 deletions

‎tcdebrepo-server/src/main/java/debrepo/teamcity/entity/DebPackageEntityWrapper.java‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎tcdebrepo-server/src/main/java/debrepo/teamcity/entity/helper/DebPackageToPackageDescriptionBuilder.java‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,35 @@
55

66
import debrepo.teamcity.entity.DebPackageEntity;
77

8+
/**
9+
* <p>
10+
* Responsible for generating a Debian Repository compliant Package
11+
* listing by extracting the text from the parameters map in the
12+
* DebPackageEntity. The output assembled into the Packages.gz file.
13+
* </p>
14+
*
15+
* <p>
16+
* Package: must be the first line, and package entries must have
17+
* a line break between entries.</p>
18+
*
19+
* <p>
20+
* An example listing looks like this:</p>
21+
* <pre>
22+
* Package: tcDummbyDeb
23+
* Version: 1.0.153
24+
* Architecture: i386
25+
* Filename: pool/main/tcDummbyDeb/tcDummyDeb_i386_1.0.153.deb
26+
* Maintainer: Net Wolf UK
27+
* Priority: optional
28+
* Section: misc
29+
* Size: 624
30+
* MD5sum: e8d5ce3ca9a4133b1a989e9babd73c5
31+
* SHA1: 5660a5ee25ca7dc67b4ad2fd285afb2314879c10
32+
* SHA256: 51d0b1eca9774272921f06082648d97eef4e1067c76bce54fdb02ed9f1b74d
33+
* Description: my first sample application which isn't doing anything special.
34+
* </pre>
35+
*/
36+
837
public class DebPackageToPackageDescriptionBuilder {
938

1039
public static String buildPackageDescription(DebPackageEntity debPackageEntity) {

‎tcdebrepo-server/src/main/java/debrepo/teamcity/entity/helper/DebRepositoryConfigurationJaxHelperImpl.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@
3333

3434
import debrepo.teamcity.entity.DebRepositoryConfigurations;
3535

36+
/**
37+
* Reads and writes to the <code>.BuildServer/config/deb-repositories.xml</code> file
38+
* using JAXB. This file is used to configure the list of repositories, which projects
39+
* they belong too, which BuildTypes contribute to the repository and what artifact filters
40+
* packages are matched against.
41+
*/
3642
public class DebRepositoryConfigurationJaxHelperImpl implements JaxHelper<DebRepositoryConfigurations> {
3743

3844
@Override

‎tcdebrepo-server/src/main/java/debrepo/teamcity/entity/helper/DebRepositoryDatabaseJaxHelperImpl.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333

3434
import debrepo.teamcity.entity.DebPackageStoreEntity;
3535

36+
/**
37+
* Reads and writes to the <code>.BuildServer/system/pluginData/tcDebRepository/database/*.xml</code> files
38+
* using JAXB. These persist the in memory datastore to/from the disk.
39+
*/
3640
public class DebRepositoryDatabaseJaxHelperImpl implements JaxHelper<DebPackageStoreEntity> {
3741

3842
@Override

‎tcdebrepo-server/src/main/java/debrepo/teamcity/entity/helper/PluginDataResolverImpl.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ public String getPluginConfigurationFile() {
5858

5959
@Override
6060
public String getPluginTempFileDirectory() {
61-
// TODO Auto-generated method stub
6261
File tempDirPath = new File(this.myServerPaths.getPluginDataDirectory()
6362
+ File.separator + TC_DEB_REPOSITORY_DIRECTORY_NAME
6463
+ File.separator + TC_DEB_REPOSITORY_TEMP_DIRECTORY_NAME);

‎tcdebrepo-server/src/main/java/debrepo/teamcity/service/DebRepositoryManager.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
import java.util.Set;
2020
import java.util.UUID;
2121

22-
import debrepo.teamcity.archive.DebFileReader;
2322
import debrepo.teamcity.entity.DebPackageEntity;
2423
import debrepo.teamcity.entity.DebPackageStore;
2524
import debrepo.teamcity.entity.DebRepositoryConfiguration;
@@ -35,7 +34,6 @@ public interface DebRepositoryManager {
3534
public boolean persist(UUID uuid);
3635
public DebRepositoryStatistics getRepositoryStatistics(String uuid, String repoUrl);
3736
public DebRepositoryStatistics getRepositoryStatistics(DebRepositoryConfiguration projectConfig, String repoUrl);
38-
public void addBuildPackages(String buildTypeId, List<DebPackageEntity> debPackageEntities, DebFileReader debFileReader);
3937
public void addBuildPackage(DebRepositoryConfiguration config, DebPackageEntity newEntity);
4038
public Set<String> findUniqueArchByDistAndComponent(String repoName, String distName, String component) throws NonExistantRepositoryException;
4139
public Set<String> findUniqueComponentByDist(String repoName, String distName) throws NonExistantRepositoryException;

‎tcdebrepo-server/src/main/java/debrepo/teamcity/service/DebRepositoryManagerImpl.java‎

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
import org.springframework.stereotype.Service;
2929

3030
import debrepo.teamcity.Loggers;
31-
import debrepo.teamcity.archive.DebFileReader;
3231
import debrepo.teamcity.entity.DebPackageEntity;
3332
import debrepo.teamcity.entity.DebPackageEntityKey;
3433
import debrepo.teamcity.entity.DebPackageStore;
@@ -233,51 +232,6 @@ public DebRepositoryStatistics getRepositoryStatistics(String uuid, String repoU
233232
return new DebRepositoryStatistics(repositories.get(UUID.fromString(uuid)).size(), repoURL);
234233
}
235234

236-
@Override
237-
public void addBuildPackages(String buildTypeId, List<DebPackageEntity> debPackageEntities, DebFileReader debFileReader) {
238-
239-
for (DebPackageEntity entity : debPackageEntities){
240-
boolean entityAdded = false;
241-
for (DebRepositoryConfiguration config : repositoryMetaData.values()) {
242-
if (config.containsBuildTypeAndFilter(entity)) {
243-
if (!entity.isPopulated()) {
244-
try {
245-
entity.populateMetadata(debFileReader.getMetaDataFromPackage(entity.getFilename()));
246-
} catch (IOException e) {
247-
Loggers.SERVER.warn("DebRepositoryManagerImpl :: Failed to read data from package: "
248-
+ entity.getFilename() + " Package will not be added to respository "
249-
+ config.getRepoName());
250-
if (Loggers.SERVER.isDebugEnabled()) { Loggers.SERVER.debug(e); }
251-
}
252-
}
253-
if (entity.isPopulated()) {
254-
try {
255-
getPackageStore(config.getRepoName()).put(entity.buildKey(), entity);
256-
entityAdded = true;
257-
persist(config.getUuid());
258-
} catch (NonExistantRepositoryException e) {
259-
Loggers.SERVER.warn("DebRepositoryManagerImpl :: Failed to add package: "
260-
+ entity.getFilename() + " Non-existant respository "
261-
+ config.getRepoName());
262-
if (Loggers.SERVER.isDebugEnabled()) { Loggers.SERVER.debug(e); }
263-
}
264-
}
265-
} else {
266-
if (Loggers.SERVER.isDebugEnabled()) { Loggers.SERVER.debug("DebRepositoryManagerImpl :: Not adding package: "
267-
+ entity.getFilename() + " to repo: " + config.getRepoName() + " (" + config.getProjectId() + ")"); }
268-
}
269-
if (Loggers.SERVER.isDebugEnabled()) {
270-
Loggers.SERVER.debug("DebRepositoryManagerImpl :: Statistics" + getRepositoryStatistics(config, ""));
271-
}
272-
}
273-
if (Loggers.SERVER.isDebugEnabled()) {
274-
if (! entityAdded) {
275-
Loggers.SERVER.debug("DebRepositoryManagerImpl :: No repo found for package: " + entity.getFilename());
276-
}
277-
}
278-
}
279-
}
280-
281235
@Override
282236
public Set<DebRepositoryConfiguration> findConfigurationsForBuildType(String buildTypeId) {
283237
Set<DebRepositoryConfiguration> configs = new TreeSet<>();

‎tcdebrepo-server/src/main/java/debrepo/teamcity/service/NonExistantRepositoryException.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
public class NonExistantRepositoryException extends Exception {
1919

2020
/**
21-
*
21+
* Thrown when a repository is requested, but does not exist.
2222
*/
2323
private static final long serialVersionUID = 1L;
2424

‎tcdebrepo-server/src/main/java/debrepo/teamcity/settings/DebRepoConfigChangeHandler.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616

1717
package debrepo.teamcity.settings;
1818

19+
/**
20+
* Handles changes to the deb-respositories.xml file.
21+
*/
1922
public interface DebRepoConfigChangeHandler {
23+
/**
24+
* Called whenever a change is detected.
25+
*/
2026
public abstract void handleConfigFileChange();
2127
}

‎tcdebrepo-server/src/main/java/debrepo/teamcity/settings/DebRepoProjectSettings.java‎

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)