mirror of https://github.com/apache/archiva.git
fix javadoc. Generation possible on jdk8
(fix html content + replace @todo with TODO ) git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1571532 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
0b3773952c
commit
764c9d6424
|
@ -56,7 +56,7 @@ import java.util.Properties;
|
|||
* ArchivaCli
|
||||
*
|
||||
*
|
||||
* @todo add back reading of archiva.xml from a given location
|
||||
* TODO add back reading of archiva.xml from a given location
|
||||
*/
|
||||
public class ArchivaCli
|
||||
{
|
||||
|
|
|
@ -35,9 +35,9 @@ import java.util.regex.Pattern;
|
|||
|
||||
/**
|
||||
* ChecksummedFile
|
||||
* <p/>
|
||||
*
|
||||
* <p>Terminology:</p>
|
||||
* <dl>
|
||||
* <lh>Terminology:</lh>
|
||||
* <dt>Checksum File</dt>
|
||||
* <dd>The file that contains the previously calculated checksum value for the reference file.
|
||||
* This is a text file with the extension ".sha1" or ".md5", and contains a single entry
|
||||
|
@ -120,12 +120,12 @@ public class ChecksummedFile
|
|||
* <p>
|
||||
* Given a checksum file, check to see if the file it represents is valid according to the checksum.
|
||||
* </p>
|
||||
* <p/>
|
||||
*
|
||||
* <p>
|
||||
* NOTE: Only supports single file checksums of type MD5 or SHA1.
|
||||
* </p>
|
||||
*
|
||||
* @param checksumFile the algorithms to check for.
|
||||
* @param algorithm the algorithms to check for.
|
||||
* @return true if the checksum is valid for the file it represents. or if the checksum file does not exist.
|
||||
* @throws IOException if the reading of the checksumFile or the file it refers to fails.
|
||||
*/
|
||||
|
@ -304,10 +304,10 @@ public class ChecksummedFile
|
|||
|
||||
/**
|
||||
* Parse a checksum string.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Validate the expected path, and expected checksum algorithm, then return
|
||||
* the trimmed checksum hex string.
|
||||
*
|
||||
* </p>
|
||||
* @param rawChecksumString
|
||||
* @param expectedHash
|
||||
* @param expectedPath
|
||||
|
|
|
@ -29,24 +29,26 @@ import java.util.List;
|
|||
|
||||
/**
|
||||
* VersionComparator - compare the parts of two version strings.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Technique.
|
||||
* <p/>
|
||||
* </p>
|
||||
* <p>
|
||||
* * Split the version strings into parts by splitting on <code>"-._"</code> first, then breaking apart words from numbers.
|
||||
* <p/>
|
||||
* </p>
|
||||
* <code>
|
||||
* "1.0" = "1", "0"
|
||||
* "1.0-alpha-1" = "1", "0", "alpha", "1"
|
||||
* "2.0-rc2" = "2", "0", "rc", "2"
|
||||
* "1.3-m2" = "1", "3", "m", "3"
|
||||
* </code>
|
||||
* <p/>
|
||||
* <p>
|
||||
* compare each part individually, and when they do not match, perform the following test.
|
||||
* <p/>
|
||||
* </p>
|
||||
* <p>
|
||||
* Numbers are calculated per normal comparison rules.
|
||||
* Words that are part of the "special word list" will be treated as their index within that heirarchy.
|
||||
* Words that cannot be identified as special, are treated using normal case-insensitive comparison rules.
|
||||
*
|
||||
* </p>
|
||||
*
|
||||
*/
|
||||
public class VersionComparator
|
||||
|
|
|
@ -55,7 +55,7 @@ public class VersionUtil
|
|||
* <p>
|
||||
* Tests if the unknown string contains elements that identify it as a version string (or not).
|
||||
* </p>
|
||||
* <p/>
|
||||
*
|
||||
* <p>
|
||||
* The algorithm tests each part of the string that is delimited by a '-' (dash) character.
|
||||
* If 75% or more of the sections are identified as 'version' strings, the result is
|
||||
|
@ -100,7 +100,7 @@ public class VersionUtil
|
|||
* <p>
|
||||
* Tests if the identifier is a known simple version keyword.
|
||||
* </p>
|
||||
* <p/>
|
||||
*
|
||||
* <p>
|
||||
* This method is different from {@link #isVersion(String)} in that it tests the whole input string in
|
||||
* one go as a simple identifier. (eg "alpha", "1.0", "beta", "debug", "latest", "rc#", etc...)
|
||||
|
@ -146,14 +146,14 @@ public class VersionUtil
|
|||
* <p>
|
||||
* Get the release version of the snapshot version.
|
||||
* </p>
|
||||
* <p/>
|
||||
*
|
||||
* <p>
|
||||
* If snapshot version is 1.0-SNAPSHOT, then release version would be 1.0
|
||||
* And if snapshot version is 1.0-20070113.163208-1.jar, then release version would still be 1.0
|
||||
* </p>
|
||||
*
|
||||
* @param snapshotVersion
|
||||
* @return
|
||||
* @param snapshotVersion snapshot version
|
||||
* @return release version
|
||||
*/
|
||||
public static String getReleaseVersion( String snapshotVersion )
|
||||
{
|
||||
|
|
|
@ -583,7 +583,7 @@ public class DefaultArchivaConfiguration
|
|||
|
||||
/**
|
||||
* Attempts to write the contents to a file, if an IOException occurs, return false.
|
||||
* <p/>
|
||||
* <p>
|
||||
* The file will be created if the directory to the file exists, otherwise this will return false.
|
||||
*
|
||||
* @param filetype the filetype (freeform text) to use in logging messages when failure to write.
|
||||
|
|
|
@ -86,18 +86,16 @@ public class FileTypes
|
|||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Get the list of patterns for a specified filetype.
|
||||
* </p>
|
||||
* <p/>
|
||||
*
|
||||
* <p>
|
||||
* You will always get a list. In this order.
|
||||
* <ul>
|
||||
* <li>The Configured List</li>
|
||||
* <li>The Default List</li>
|
||||
* <li>A single item list of <code>"**<span>/</span>*"</code></li>
|
||||
* <li>A single item list of <code>"**/*"</code></li>
|
||||
* </ul>
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @param id the id to lookup.
|
||||
* @return the list of patterns.
|
||||
|
|
|
@ -36,14 +36,14 @@ public interface RepositoryContentConsumer
|
|||
/**
|
||||
* Get the list of included file patterns for this consumer.
|
||||
*
|
||||
* @return the list of {@link String} patterns. (example: <code>"**<span />/*.pom"</code>)
|
||||
* @return the list of {@link String} patterns. (example: <code>"**/*.pom"</code>)
|
||||
*/
|
||||
List<String> getIncludes();
|
||||
|
||||
/**
|
||||
* Get the list of excluded file patterns for this consumer.
|
||||
*
|
||||
* @return the list of {@link String} patterns. (example: <code>"**<span />/*.pom"</code>) - (can be null for no exclusions)
|
||||
* @return the list of {@link String} patterns. (example: <code>"**/*.pom"</code>) - (can be null for no exclusions)
|
||||
*/
|
||||
List<String> getExcludes();
|
||||
|
||||
|
@ -51,7 +51,6 @@ public interface RepositoryContentConsumer
|
|||
* <p>
|
||||
* Event that triggers at the beginning of a scan.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* NOTE: This would be a good place to initialize the consumer, to lock any resources, and to
|
||||
* generally start tracking the scan as a whole.
|
||||
|
@ -83,7 +82,6 @@ public interface RepositoryContentConsumer
|
|||
* <p>
|
||||
* Event indicating a file is to be processed by this consumer.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* NOTE: The consumer does not need to process the file immediately, can can opt to queue and/or track
|
||||
* the files to be processed in batch. Just be sure to complete the processing by the {@link #completeScan()}
|
||||
|
@ -108,7 +106,6 @@ public interface RepositoryContentConsumer
|
|||
* <p>
|
||||
* Event that triggers on the completion of a scan.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* NOTE: If the consumer opted to batch up processing requests in the {@link #processFile(String)} event
|
||||
* this would be the last opportunity to drain any processing queue's.
|
||||
|
@ -118,7 +115,6 @@ public interface RepositoryContentConsumer
|
|||
|
||||
/**
|
||||
* @param executeOnEntireRepo
|
||||
* @throws Exception
|
||||
*/
|
||||
void completeScan( boolean executeOnEntireRepo );
|
||||
|
||||
|
|
|
@ -50,7 +50,6 @@ import java.util.List;
|
|||
* This will look in a single managed repository, and purge any snapshots that are present
|
||||
* that have a corresponding released version on the same repository.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* So, if you have the following (presented in the m2/default layout form) ...
|
||||
* <pre>
|
||||
|
@ -65,9 +64,6 @@ import java.util.List;
|
|||
* then the current highest ranked released (non-snapshot) version is 2.0, which means
|
||||
* the snapshots from 1.0-SNAPSHOT, 1.1-SNAPSHOT, 1.2.1-SNAPSHOT, and 2.0-SNAPSHOT can
|
||||
* be purged. Leaving 2.1-SNAPSHOT in alone.
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
*/
|
||||
public class CleanupReleasedSnapshotsRepositoryPurge
|
||||
extends AbstractRepositoryPurge
|
||||
|
|
|
@ -39,7 +39,7 @@ import java.util.Map;
|
|||
|
||||
/**
|
||||
* Simple component which will initiate the plexus shim component
|
||||
* to see plexus components inside a guice container.<br/>
|
||||
* to see plexus components inside a guice container.<br>
|
||||
* So move all of this here to be able to change quickly if needed.
|
||||
*
|
||||
* @author Olivier Lamy
|
||||
|
|
|
@ -47,7 +47,7 @@ public interface Policy
|
|||
/**
|
||||
* Get the display name for this policy.
|
||||
*
|
||||
* @todo i18n
|
||||
* TODO todo i18n
|
||||
*
|
||||
* @return the name for this policy
|
||||
*/
|
||||
|
|
|
@ -101,7 +101,7 @@ import java.util.concurrent.ConcurrentHashMap;
|
|||
/**
|
||||
* DefaultRepositoryProxyConnectors
|
||||
*
|
||||
* @todo exception handling needs work - "not modified" is not really an exceptional case, and it has more layers than
|
||||
* TODO exception handling needs work - "not modified" is not really an exceptional case, and it has more layers than
|
||||
* your average brown onion
|
||||
*/
|
||||
@Service("repositoryProxyConnectors#default")
|
||||
|
@ -922,9 +922,7 @@ public class DefaultRepositoryProxyConnectors
|
|||
* @param remotePath the remote path to attempt to get
|
||||
* @param repository the managed repository that will hold the file
|
||||
* @param origFile the local file to save to
|
||||
* @return The local file that was transfered.
|
||||
* @throws ProxyException if there was a problem moving the downloaded file into place.
|
||||
* @throws WagonException if there was a problem tranfering the file.
|
||||
*/
|
||||
private void transferSimpleFile( Wagon wagon, RemoteRepositoryContent remoteRepository, String remotePath,
|
||||
ManagedRepositoryContent repository, File origFile, File destFile )
|
||||
|
@ -992,6 +990,7 @@ public class DefaultRepositoryProxyConnectors
|
|||
* @param request the request properties (utilized by the {@link DownloadPolicy#applyPolicy(String, Properties, File)}
|
||||
* )
|
||||
* @param localFile the local file (utilized by the {@link DownloadPolicy#applyPolicy(String, Properties, File)})
|
||||
* @throws PolicyViolationException
|
||||
*/
|
||||
private void validatePolicies( Map<String, ? extends DownloadPolicy> policies, Map<String, String> settings,
|
||||
Properties request, File localFile )
|
||||
|
@ -1078,7 +1077,6 @@ public class DefaultRepositoryProxyConnectors
|
|||
*
|
||||
* @param repository
|
||||
* @return file location of working directory
|
||||
* @throws IOException
|
||||
*/
|
||||
private File createWorkingDirectory( ManagedRepositoryContent repository )
|
||||
{
|
||||
|
|
|
@ -75,7 +75,6 @@ public interface ManagedRepositoryContent
|
|||
* <p>
|
||||
* Convenience method to get the repository id.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* Equivalent to calling <code>.getRepository().getId()</code>
|
||||
* </p>
|
||||
|
@ -90,7 +89,6 @@ public interface ManagedRepositoryContent
|
|||
* This typically inclues the pom files, and those things with
|
||||
* classifiers (such as doc, source code, test libs, etc...)
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* <strong>NOTE:</strong> Some layouts (such as maven 1 "legacy") are not compatible with this query.
|
||||
* </p>
|
||||
|
@ -98,7 +96,6 @@ public interface ManagedRepositoryContent
|
|||
* @param reference the reference to work off of.
|
||||
* @return the set of ArtifactReferences for related artifacts.
|
||||
* @throws ContentNotFoundException if the initial artifact reference does not exist within the repository.
|
||||
* @throws LayoutException
|
||||
*/
|
||||
Set<ArtifactReference> getRelatedArtifacts( ArtifactReference reference )
|
||||
throws ContentNotFoundException;
|
||||
|
@ -107,7 +104,6 @@ public interface ManagedRepositoryContent
|
|||
* <p>
|
||||
* Convenience method to get the repository (on disk) root directory.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* Equivalent to calling <code>.getRepository().getLocation()</code>
|
||||
* </p>
|
||||
|
@ -141,7 +137,6 @@ public interface ManagedRepositoryContent
|
|||
* Given a specific {@link VersionedReference}, return the list of available versions for that
|
||||
* versioned reference.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* <strong>NOTE:</strong> This is really only useful when working with SNAPSHOTs.
|
||||
* </p>
|
||||
|
@ -149,7 +144,6 @@ public interface ManagedRepositoryContent
|
|||
* @param reference the versioned reference to work off of.
|
||||
* @return the set of versions found.
|
||||
* @throws ContentNotFoundException if the versioned reference does not exist within the repository.
|
||||
* @throws LayoutException
|
||||
*/
|
||||
Set<String> getVersions( VersionedReference reference )
|
||||
throws ContentNotFoundException;
|
||||
|
|
|
@ -75,7 +75,7 @@ public interface RemoteRepositoryContent
|
|||
void setRepository( RemoteRepository repo );
|
||||
|
||||
/**
|
||||
* Given a repository relative path to a filename, return the {@link VersionedReference} object suitable for the path.
|
||||
* Given a repository relative path to a filename, return the {@link org.apache.archiva.model.VersionedReference} object suitable for the path.
|
||||
*
|
||||
* @param path the path relative to the repository base dir for the artifact.
|
||||
* @return the {@link ArtifactReference} representing the path. (or null if path cannot be converted to
|
||||
|
|
|
@ -25,7 +25,7 @@ import java.util.Map;
|
|||
/**
|
||||
* Maven 1.x request type to classifier mapping for translating to a Maven 2.x storage
|
||||
*
|
||||
* @todo reuse mappings for other repositories
|
||||
* TODO reuse mappings for other repositories
|
||||
*
|
||||
* @since 1.1
|
||||
*/
|
||||
|
|
|
@ -547,7 +547,7 @@ public class MetadataTools
|
|||
* based off of information present in the repository,
|
||||
* the maven-metadata.xml files, and the proxy/repository specific
|
||||
* metadata file contents.
|
||||
* <p/>
|
||||
* <p>
|
||||
* We must treat this as a group or a project metadata file as there is no way to know in advance
|
||||
*
|
||||
* @param managedRepository the managed repository where the metadata is kept.
|
||||
|
@ -754,7 +754,7 @@ public class MetadataTools
|
|||
|
||||
/**
|
||||
* Update the metadata based on the following rules.
|
||||
* <p/>
|
||||
* <p>
|
||||
* 1) If this is a SNAPSHOT reference, then utilize the proxy/repository specific
|
||||
* metadata files to represent the current / latest SNAPSHOT available.
|
||||
* 2) If this is a RELEASE reference, and the metadata file does not exist, then
|
||||
|
|
|
@ -79,7 +79,6 @@ public class RepositoryContentConsumers
|
|||
* Get the list of Ids associated with those {@link KnownRepositoryContentConsumer} that have
|
||||
* been selected in the configuration to execute.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* NOTE: This list can be larger and contain entries that might not exist or be available
|
||||
* in the classpath, or as a component.
|
||||
|
@ -98,7 +97,6 @@ public class RepositoryContentConsumers
|
|||
* Get the list of Ids associated with those {@link InvalidRepositoryContentConsumer} that have
|
||||
* been selected in the configuration to execute.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p>
|
||||
* NOTE: This list can be larger and contain entries that might not exist or be available
|
||||
* in the classpath, or as a component.
|
||||
|
|
|
@ -43,11 +43,9 @@ public interface RepositoryScanner
|
|||
* <p>
|
||||
* Typical Ignorable Content patterns.
|
||||
* </p>
|
||||
* <p/>
|
||||
* <p><strong>
|
||||
* NOTE: Do not use for normal webapp or task driven repository scanning.
|
||||
* </strong></p>
|
||||
* <p/>
|
||||
* </strong></p>
|
||||
* <p>
|
||||
* These patterns are only valid for archiva-cli and archiva-converter use.
|
||||
* </p>
|
||||
|
@ -59,7 +57,7 @@ public interface RepositoryScanner
|
|||
|
||||
/**
|
||||
* Scan the repository for content changes.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Internally, this will use the as-configured known and invalid consumer lists.
|
||||
*
|
||||
* @param repository the repository to change.
|
||||
|
@ -74,7 +72,7 @@ public interface RepositoryScanner
|
|||
|
||||
/**
|
||||
* Scan the repository for content changes.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Internally, this will use the as-configured known and invalid consumer lists.
|
||||
*
|
||||
* @param repository the repository to change.
|
||||
|
|
|
@ -25,8 +25,8 @@ import java.util.List;
|
|||
/**
|
||||
* Generator of list of random test method
|
||||
* -Dorg.apache.archiva.test=n
|
||||
* n<=0 default jdk behavior
|
||||
* n>0 number of round of random collection
|
||||
* n<=0 default jdk behavior
|
||||
* n>0 number of round of random collection
|
||||
*
|
||||
* @author Eric
|
||||
*/
|
||||
|
|
|
@ -47,7 +47,7 @@ public abstract class AbstractTransactionEvent
|
|||
private List<File> createdFiles = new ArrayList<File>();
|
||||
|
||||
/**
|
||||
* {@link List}<{@link Digester}>
|
||||
* {@link List}<{@link Digester}>
|
||||
*/
|
||||
private List<? extends Digester> digesters;
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ public class CopyFileEvent
|
|||
*
|
||||
* @param source
|
||||
* @param destination
|
||||
* @param digesters {@link List}<{@link Digester}> digesters to use for checksumming
|
||||
* @param digesters {@link List}<{@link Digester}> digesters to use for checksumming
|
||||
*/
|
||||
public CopyFileEvent( File source, File destination, List<? extends Digester> digesters )
|
||||
{
|
||||
|
|
|
@ -41,7 +41,7 @@ public class CreateFileEvent
|
|||
*
|
||||
* @param content
|
||||
* @param destination
|
||||
* @param digesters {@link List}<{@link Digester}> digesters to use for checksumming
|
||||
* @param digesters {@link List}<{@link Digester}> digesters to use for checksumming
|
||||
*/
|
||||
public CreateFileEvent( String content, File destination, List<? extends Digester> digesters )
|
||||
{
|
||||
|
|
|
@ -77,7 +77,7 @@ public class FileTransaction
|
|||
/**
|
||||
* @param source
|
||||
* @param destination
|
||||
* @param digesters {@link List}<{@link org.codehaus.plexus.digest.Digester}> digesters to use for checksumming
|
||||
* @param digesters {@link List}<{@link org.codehaus.plexus.digest.Digester}> digesters to use for checksumming
|
||||
*/
|
||||
public void copyFile( File source, File destination, List<? extends Digester> digesters )
|
||||
{
|
||||
|
@ -87,7 +87,7 @@ public class FileTransaction
|
|||
/**
|
||||
* @param content
|
||||
* @param destination
|
||||
* @param digesters {@link List}<{@link org.codehaus.plexus.digest.Digester}> digesters to use for checksumming
|
||||
* @param digesters {@link List}<{@link org.codehaus.plexus.digest.Digester}> digesters to use for checksumming
|
||||
*/
|
||||
public void createFile( String content, File destination, List<? extends Digester> digesters )
|
||||
{
|
||||
|
|
|
@ -88,7 +88,7 @@ public class ArchivaIndexingTaskExecutor
|
|||
|
||||
/**
|
||||
* depending on current {@link Task} you have.
|
||||
* If {@link org.apache.archiva.scheduler.indexing.ArtifactIndexingTask.Action#FINISH} && isExecuteOnEntireRepo:
|
||||
* If {@link org.apache.archiva.scheduler.indexing.ArtifactIndexingTask.Action#FINISH} && isExecuteOnEntireRepo:
|
||||
* repository will be scanned.
|
||||
*
|
||||
* @param task
|
||||
|
|
|
@ -32,7 +32,7 @@ import javax.inject.Named;
|
|||
/**
|
||||
* Default implementation of a scheduling component for archiva.
|
||||
*
|
||||
* @todo TODO - consider just folding in, not really scheduled
|
||||
* TODO - consider just folding in, not really scheduled
|
||||
*/
|
||||
@Service("archivaTaskScheduler#indexing")
|
||||
public class IndexingArchivaTaskScheduler
|
||||
|
|
|
@ -23,7 +23,7 @@ import java.io.Serializable;
|
|||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* @author Adrien Lecharpentier <alecharp@apache.org>
|
||||
* @author Adrien Lecharpentier <alecharp@apache.org>
|
||||
* @since 1.4-M4
|
||||
*/
|
||||
@XmlRootElement( name = "metadataAddRequest" )
|
||||
|
|
|
@ -24,7 +24,7 @@ import java.util.ArrayList;
|
|||
import java.util.List;
|
||||
|
||||
/**
|
||||
* jaxrs fail to return List<String> so use this contains for rest services returning that
|
||||
* jaxrs fail to return List<String> so use this contains for rest services returning that
|
||||
*
|
||||
* @author Olivier Lamy
|
||||
* @since 1.4-M3
|
||||
|
|
|
@ -103,7 +103,7 @@ public interface ManagedRepositoriesService
|
|||
throws ArchivaRestServiceException;
|
||||
|
||||
/**
|
||||
* return a pom snippet to use this repository with entities escaped (< > )
|
||||
* return a pom snippet to use this repository with entities escaped (< >)
|
||||
* @since 1.4-M3
|
||||
*/
|
||||
@Path( "getPomSnippet/{repositoryId}" )
|
||||
|
|
|
@ -35,7 +35,7 @@ import java.util.List;
|
|||
/**
|
||||
* ReportRepositoriesService
|
||||
*
|
||||
* @author Adrien Lecharpentier <adrien.lecharpentier@zenika.com>
|
||||
* @author Adrien Lecharpentier <adrien.lecharpentier@zenika.com>
|
||||
* @since 1.4-M3
|
||||
*/
|
||||
@Path( "/reportServices/" )
|
||||
|
|
|
@ -1044,7 +1044,7 @@ public class DefaultBrowseService
|
|||
|
||||
/**
|
||||
* @param path
|
||||
* @return org/apache -> org , org -> org
|
||||
* @return org/apache -> org , org -> org
|
||||
*/
|
||||
private String getRootPath( String path )
|
||||
{
|
||||
|
|
|
@ -38,7 +38,7 @@ import java.util.List;
|
|||
/**
|
||||
* DefaultReportRepositoriesService
|
||||
*
|
||||
* @author Adrien Lecharpentier <adrien.lecharpentier@zenika.com>
|
||||
* @author Adrien Lecharpentier <adrien.lecharpentier@zenika.com>
|
||||
* @since 1.4-M3
|
||||
*/
|
||||
@Service( "reportRepositoriesService#rest" )
|
||||
|
|
|
@ -53,7 +53,7 @@ public interface ServletAuthenticator
|
|||
* @param request
|
||||
* @param securitySession
|
||||
* @param repositoryId
|
||||
* @param isWriteRequest
|
||||
* @param permission
|
||||
* @return
|
||||
* @throws AuthorizationException
|
||||
* @throws UnauthorizedException
|
||||
|
@ -70,7 +70,7 @@ public interface ServletAuthenticator
|
|||
*
|
||||
* @param principal
|
||||
* @param repoId
|
||||
* @param isWriteRequest
|
||||
* @param permission
|
||||
* @return
|
||||
* @throws UnauthorizedException
|
||||
*/
|
||||
|
|
|
@ -26,7 +26,7 @@ import java.io.Serializable;
|
|||
/**
|
||||
* Information about the CI system used by the project.
|
||||
*
|
||||
* @todo considering moving this to a facet - avoid referring to it externally
|
||||
* TODO considering moving this to a facet - avoid referring to it externally
|
||||
*/
|
||||
@XmlRootElement(name = "ciManagement")
|
||||
public class CiManagement
|
||||
|
|
|
@ -25,7 +25,7 @@ import java.io.Serializable;
|
|||
/**
|
||||
* Information about a dependency that this project has on another project or artifact.
|
||||
*
|
||||
* @todo will be reviewing what is appropriate for the base here - rest should be in a maven dependency facet - avoid details on it externally
|
||||
* TODO will be reviewing what is appropriate for the base here - rest should be in a maven dependency facet - avoid details on it externally
|
||||
*/
|
||||
@XmlRootElement(name = "dependency")
|
||||
public class Dependency
|
||||
|
|
|
@ -26,7 +26,7 @@ import java.io.Serializable;
|
|||
/**
|
||||
* Information about the issue management system used by the project.
|
||||
*
|
||||
* @todo considering moving this to a facet - avoid referring to it externally
|
||||
* TODO considering moving this to a facet - avoid referring to it externally
|
||||
*/
|
||||
@XmlRootElement(name = "issueManagement")
|
||||
public class IssueManagement
|
||||
|
|
|
@ -26,7 +26,7 @@ import java.util.List;
|
|||
/**
|
||||
* Information about the available mailing lists for communicating with the project.
|
||||
*
|
||||
* @todo considering moving this to a facet - avoid referring to it externally
|
||||
* TODO considering moving this to a facet - avoid referring to it externally
|
||||
*/
|
||||
@XmlRootElement(name = "mailingList")
|
||||
public class MailingList
|
||||
|
|
|
@ -43,19 +43,19 @@ import java.util.List;
|
|||
/**
|
||||
* Default implementation of the metadata resolver API. At present it will handle updating the content repository
|
||||
* from new or changed information in the model and artifacts from the repository storage.
|
||||
* <p/>
|
||||
* <p>
|
||||
* This is a singleton component to allow an alternate implementation to be provided. It is intended to be the same
|
||||
* system-wide for the whole content repository instead of on a per-managed-repository basis. Therefore, the session is
|
||||
* passed in as an argument to obtain any necessary resources, rather than the class being instantiated within the
|
||||
* session in the context of a single managed repository's resolution needs.
|
||||
* <p/>
|
||||
* <p>
|
||||
* Note that the caller is responsible for the session, such as closing and saving (which is implied by the resolver
|
||||
* being obtained from within the session). The {@link RepositorySession#markDirty()} method is used as a hint to ensure
|
||||
* that the session knows we've made changes at close. We cannot ensure the changes will be persisted if the caller
|
||||
* chooses to revert first. This is preferable to storing the metadata immediately - a separate session would require
|
||||
* having a bi-directional link with the session factory, and saving the existing session might save other changes
|
||||
* unknowingly by the caller.
|
||||
* <p/>
|
||||
* <p>
|
||||
*/
|
||||
@Service ("metadataResolver#default")
|
||||
public class DefaultMetadataResolver
|
||||
|
@ -67,7 +67,7 @@ public class DefaultMetadataResolver
|
|||
/**
|
||||
* FIXME: this needs to be configurable based on storage type - and could also be instantiated per repo. Change to a
|
||||
* factory, and perhaps retrieve from the session. We should avoid creating one per request, however.
|
||||
* <p/>
|
||||
* <p>
|
||||
* TODO: Also need to accommodate availability of proxy module
|
||||
* ... could be a different type since we need methods to modify the storage metadata, which would also allow more
|
||||
* appropriate methods to pass in the already determined repository configuration, for example, instead of the ID
|
||||
|
|
|
@ -205,7 +205,7 @@ public interface MetadataRepository
|
|||
* @param namespace
|
||||
* @param projectId
|
||||
* @param projectVersion
|
||||
* @throws MetadataResolutionException
|
||||
* @throws MetadataRepositoryException
|
||||
* @since 1.4-M4
|
||||
*/
|
||||
void removeProjectVersion( String repoId, String namespace, String projectId, String projectVersion )
|
||||
|
|
|
@ -28,10 +28,10 @@ import org.apache.archiva.metadata.repository.storage.RepositoryStorageMetadataE
|
|||
* Listen to events on the repository. This class is a stopgap
|
||||
* refactoring measure until an event bus is in place to handle
|
||||
* generic events such as these.
|
||||
* <p/>
|
||||
* <p>
|
||||
* This assumes that the events occur before the action has completed, though they don't currently offer any mechanism
|
||||
* to prevent an event from occurring or guarantee that it will happen.
|
||||
* <p/>
|
||||
* <p>
|
||||
* FIXME: this needs to be made more permanent since 3rd party plugins will depend on it heavily
|
||||
*/
|
||||
public interface RepositoryListener
|
||||
|
|
|
@ -29,14 +29,14 @@ public interface Auditable
|
|||
/**
|
||||
* Add an AuditListener.
|
||||
*
|
||||
* @param the listener to add.
|
||||
* @param auditListener the listener to add.
|
||||
*/
|
||||
void addAuditListener( AuditListener auditListener );
|
||||
|
||||
/**
|
||||
* Remove an AuditListener.
|
||||
*
|
||||
* @param the listener to remove.
|
||||
* @param auditListener the listener to remove.
|
||||
*/
|
||||
void removeAuditListener( AuditListener auditListener );
|
||||
|
||||
|
|
|
@ -102,10 +102,10 @@ import java.util.Map;
|
|||
* Maven 2 repository format storage implementation. This class currently takes parameters to indicate the repository to
|
||||
* deal with rather than being instantiated per-repository.
|
||||
* FIXME: instantiate one per repository and allocate permanently from a factory (which can be obtained within the session).
|
||||
* <p/>
|
||||
* <p>
|
||||
* The session is passed in as an argument to obtain any necessary resources, rather than the class being instantiated
|
||||
* within the session in the context of a single managed repository's resolution needs.
|
||||
* <p/>
|
||||
* <p>
|
||||
*/
|
||||
@Service( "repositoryStorage#maven2" )
|
||||
public class Maven2RepositoryStorage
|
||||
|
@ -643,7 +643,7 @@ public class Maven2RepositoryStorage
|
|||
* A relocation capable client will request the POM prior to the artifact, and will then read meta-data and do
|
||||
* client side relocation. A simplier client (like maven 1) will only request the artifact and not use the
|
||||
* metadatas.
|
||||
* <p/>
|
||||
* <p>
|
||||
* For such clients, archiva does server-side relocation by reading itself the <relocation> element in
|
||||
* metadatas and serving the expected artifact.
|
||||
*/
|
||||
|
|
|
@ -44,7 +44,7 @@ import java.util.Set;
|
|||
* ManagedLegacyRepositoryContent
|
||||
*
|
||||
*
|
||||
* @todo no need to be a component when filetypes, legacy path parser is not
|
||||
* TODO no need to be a component when filetypes, legacy path parser is not
|
||||
*/
|
||||
@Service( "managedRepositoryContent#legacy" )
|
||||
@Scope( "prototype" )
|
||||
|
|
|
@ -32,7 +32,7 @@ import org.springframework.stereotype.Service;
|
|||
* RemoteLegacyRepositoryContent
|
||||
*
|
||||
*
|
||||
* @todo no need to be a component once legacy path parser is not
|
||||
* TODO no need to be a component once legacy path parser is not
|
||||
*/
|
||||
@Service( "remoteRepositoryContent#legacy" )
|
||||
@Scope( "prototype" )
|
||||
|
|
|
@ -31,9 +31,6 @@ import org.apache.commons.lang.StringUtils;
|
|||
/**
|
||||
* RepositoryRequest is used to determine the type of request that is incoming, and convert it to an appropriate
|
||||
* ArtifactReference.
|
||||
* <p/>
|
||||
* <p/>
|
||||
* <p/>
|
||||
*/
|
||||
public class RepositoryRequest
|
||||
{
|
||||
|
|
|
@ -69,8 +69,8 @@ import java.util.Map;
|
|||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* @todo below: revise storage format for project version metadata
|
||||
* @todo revise reference storage
|
||||
* TODO below: revise storage format for project version metadata
|
||||
* TODO revise reference storage
|
||||
*/
|
||||
public class JcrMetadataRepository
|
||||
implements MetadataRepository
|
||||
|
|
|
@ -55,7 +55,7 @@ import java.util.List;
|
|||
|
||||
/**
|
||||
* Search the artifact repository of known SHA1 Checksums for potential duplicate artifacts.
|
||||
* <p/>
|
||||
* <p>
|
||||
* TODO: no need for this to be a scanner - we can just query the database / content repository to get a full list
|
||||
*/
|
||||
@Service ( "knownRepositoryContentConsumer#duplicate-artifacts" )
|
||||
|
|
Loading…
Reference in New Issue