Apache
/
archiva
mirror of https://github.com/apache/archiva.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

remove all tab characters and fix some formatting 

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1215120 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Porter 2011-12-16 13:13:10 +00:00
parent f5183ff08b
commit 615cfd730e
39 changed files with 1060 additions and 1040 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

234
archiva-docs/src/site/apt/adminguide/repositories.apt
View File

@ -31,12 +31,14 @@ Understanding Repository Configuration of Apache Archiva
~~TODO: revise more as suggested by Jeff in the dev list
Archiva has two types of repository configuration: managed repository and remote repository.
Archiva has two types of repository configuration: managed repository and
remote repository.
* Managed Repository
A managed repository is a repository which resides locally to the server where Archiva is running. It could serve as a
proxy repository, an internal deployment repository or a local mirror repository.
A managed repository is a repository which resides locally to the server where
Archiva is running. It could serve as a proxy repository, an internal deployment
repository or a local mirror repository.
Managed repository fields:
@ -44,59 +46,73 @@ Understanding Repository Configuration of Apache Archiva
* <name> - the name of the repository.
* <directory> - the location of the repository. If the path specified does not exist, Archiva will create the missing
directories.
* <directory> - the location of the repository. If the path specified does not
exist, Archiva will create the missing directories.
* <index directory> - the location of the index files generated by Archiva. If no location is specified, then the index directory
(named <<<.indexer>>>) will be created at the root of the repository directory. Another directory named <<<.index>>> is also created
at the root of the repository directory. This is not configurable though as it contains the packaged/bundled index which is consumed
by different consumers of the index such as M2Eclipse.
* <index directory> - the location of the index files generated by Archiva. If
no location is specified, then the index directory (named <<<.indexer>>>)
will be created at the root of the repository directory. Another directory
named <<<.index>>> is also created at the root of the repository directory.
This is not configurable though as it contains the packaged/bundled index
which is consumed by different consumers of the index such as M2Eclipse.
* <type> - the repository layout (maven 2 or maven 1)
* <cron> - the {{{http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html}cron schedule}} when repository scanning will be executed.
* <cron> - the
{{{http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html}cron
schedule}} when repository scanning will be executed.
* <repository purge by days older> - the first option for repository purge. Archiva will check how old the artifact is
and if it is older than the set number of days in this field, then the artifact will be deleted respecting the retention
count (see #7) of course. In order to disable the purge by number of days old and set Archiva to purge by retention count, just set the
repository purge field to 0. The maximum number of days which can be set here is 1000. See the Repository Purge section
below for more details.
* <repository purge by days older> - the first option for repository purge.
Archiva will check how old the artifact is and if it is older than the set
number of days in this field, then the artifact will be deleted respecting
the retention count (see #7) of course. In order to disable the purge by
number of days old and set Archiva to purge by retention count, just set the
repository purge field to 0. The maximum number of days which can be set
here is 1000. See the Repository Purge section below for more details.
* <repository purge by retention count> - the second option for repository purge. When running the repository purge, Archiva
will retain only the number of artifacts set for this field for a specific snapshot version. See the Repository Purge section
below for more details.
* <repository purge by retention count> - the second option for repository
purge. When running the repository purge, Archiva will retain only the
number of artifacts set for this field for a specific snapshot version. See
the Repository Purge section below for more details.
* <releases included> - specifies whether there are released artifacts in the repository.
* <releases included> - specifies whether there are released artifacts in the
repository.
* <block re-deployment of released artifacts> - specifies whether released artifacts that are already existing in the repository can be overwritten.
* <block re-deployment of released artifacts> - specifies whether released
artifacts that are already existing in the repository can be overwritten.
Note that this only take effects for non-snapshot deployments.
* <snapshots included> - specifies whether there are snapshot artifacts in the repository.
* <snapshots included> - specifies whether there are snapshot artifacts in the
repository.
* <scannable> - specifies whether the repository can be scanned, meaning it is a local repository which can be indexed, browsed,
purged, etc.
* <scannable> - specifies whether the repository can be scanned, meaning it is
a local repository which can be indexed, browsed, purged, etc.
* <delete released snapshots> - specifies whether to remove those snapshot artifacts which already has release versions
of it in the repository during repository purge.
* <delete released snapshots> - specifies whether to remove those snapshot
artifacts which already has release versions of it in the repository during
repository purge.
[]
Each repository has its own Webdav url. This allows the user to browse and access the repository via webdav. The url has the
following format:
Each repository has its own Webdav url. This allows the user to browse and
access the repository via webdav. The url has the following format:
+----+
http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g. http://localhost:8080/archiva/repository/releases).
+----+
A pom snippet is also available for each repository. The \<distributionManagement\> section can be copied and pasted into a
project's pom to specify that the project will be deployed in that managed repository. The \<repositories\> section on the
other hand, can be copied and pasted to a project's pom.xml or to Maven's settings.xml to tell Maven to get artifacts
A pom snippet is also available for each repository. The
\<distributionManagement\> section can be copied and pasted into a project's
pom to specify that the project will be deployed in that managed repository.
The \<repositories\> section on the other hand, can be copied and pasted to a
project's pom.xml or to Maven's settings.xml to tell Maven to get artifacts
from the managed repository when building the project.
* Remote Repository
A remote repository is a repository which resides remotely. These repositories are usually the proxied repositories. See
Proxy Connectors on how to proxy a repository.
A remote repository is a repository which resides remotely. These repositories
are usually the proxied repositories. See Proxy Connectors on how to proxy a
repository.
Remote repository fields:
@ -104,27 +120,36 @@ http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g. http://localhost:8080/a
* <name> - the name of the remote repository.
* <url> - the url of the remote repository. It is also possible to use a 'file://' url to proxy a local repository. Be careful that if this local repository is a managed repository of archiva which has some proxies connectors, those ones won't be triggered.
* <url> - the url of the remote repository. It is also possible to use a
'file://' url to proxy a local repository. Be careful that if this local
repository is a managed repository of archiva which has some proxies
connectors, those ones won't be triggered.
* <username> - the username (if authentication is needed) to be used to access the repository.
* <username> - the username (if authentication is needed) to be used to access
the repository.
* <password> - the password (if authentication is needed) to be used to access the repository.
* <password> - the password (if authentication is needed) to be used to access
the repository.
* <type> - the layout (maven 2 or maven 1) of the remote repository.
* <Activate download remote index> - to activate downloading remote index to add available remote artifacts in search queries.
* <Activate download remote index> - to activate downloading remote index to
add available remote artifacts in search queries.
* <Remote index url, can be relative to url> - path of the remote index directory.
* <Remote index url, can be relative to url> - path of the remote index
directory.
* <Cron expression> - cron expression for downloading remote index (default weekly on sunday)
* <Cron expression> - cron expression for downloading remote index (default
weekly on sunday)
* <Directory index storage> - path to store index directory, default will be ${appserver.base}/data/remotes/${repositoryId}/.index
* <Download Remote Index Timeout in seconds> - read time out for downloading remote index files (default 300)
* <Network Proxy to Use for download Remote Index> - proxy to use for downloading remote index files.
* <Directory index storage> - path to store index directory, default will be
${appserver.base}/data/remotes/${repositoryId}/.index
* <Download Remote Index Timeout in seconds> - read time out for downloading
remote index files (default 300)
* <Network Proxy to Use for download Remote Index> - proxy to use for
downloading remote index files.
[../images/remote-repositories.png] Remote Repositories
@ -132,32 +157,44 @@ http://[URL TO ARCHIVA]/repository/[REPOSITORY ID] (e.g. http://localhost:8080/a
* Scanning a Repository
Repository scan can be executed on schedule or it can be explicitly executed by clicking the 'Scan Repository Now' button in
the repositories page. By default, Archiva only processes new artifacts in the repository with respect to the last run of the
repository scanner. Meaning that if the artifact's last modified date is newer than the last repository scan, then the artifact
will be processed. Otherwise, it will be skipped. You can override this behavior and force Archiva to process all artifacts regardless
of its age by ticking the 'Process All Artifacts' checkbox in the repositories page and clicking the 'Scan Repository Now' button.
Repository scan can be executed on schedule or it can be explicitly executed
by clicking the 'Scan Repository Now' button in the repositories page. By
default, Archiva only processes new artifacts in the repository with respect
to the last run of the repository scanner. Meaning that if the artifact's last
modified date is newer than the last repository scan, then the artifact will
be processed. Otherwise, it will be skipped. You can override this behavior
and force Archiva to process all artifacts regardless of its age by ticking
the 'Process All Artifacts' checkbox in the repositories page and clicking the
'Scan Repository Now' button.
[../images/repositories.png] Repositories
For every artifact found by the repository scanner, processing is done on this artifact by different
consumers. Examples of the processing done are: indexing, repository purge and database update. Details about consumers are
available in the {{{./consumers.html} Consumers}} page.
For every artifact found by the repository scanner, processing is done on this
artifact by different consumers. Examples of the processing done are: indexing,
repository purge and database update. Details about consumers are available in
the {{{./consumers.html} Consumers}} page.
* Repository Purge
Repository purge is the process of cleaning up the repository of old snapshots. When deploying a snapshot to a repository,
Maven deploys the project/artifact with a timestamped version. Doing daily/nightly builds of the project then tends to bloat
the repository. What if the artifact is large? Then disk space will definitely be a problem. That's where Archiva's repository
purge feature comes in. Given a criteria to use -- by the number of days old and by retention count, it would clean up the
repository by removing old snapshots.
Repository purge is the process of cleaning up the repository of old
snapshots. When deploying a snapshot to a repository, Maven deploys the
project/artifact with a timestamped version. Doing daily/nightly builds of the
project then tends to bloat the repository. What if the artifact is large?
Then disk space will definitely be a problem. That's where Archiva's
repository purge feature comes in. Given a criteria to use -- by the number of
days old and by retention count, it would clean up the repository by removing
old snapshots.
Please take note that the by number of days old criteria is activated by default (set to 100 days). In order to de-activate it and
use the by retention count criteria, you must set the Repository Purge By Days Older field to 0. Another thing to note here is that
if the by number of days old criteria is activated, the retention count would still be respected (See the Repository Purge By Days Older
section below for more details) but not the other way around.
Please take note that the by number of days old criteria is activated by
default (set to 100 days). In order to de-activate it and use the by retention
count criteria, you must set the Repository Purge By Days Older field to 0.
Another thing to note here is that if the by number of days old criteria is
activated, the retention count would still be respected (See the Repository
Purge By Days Older section below for more details) but not the other way
around.
Let's take a look at different behaviours for repository purge using the following scenario:
Let's take a look at different behaviours for repository purge using the
following scenario:
+----+
Artifacts in the repository:
@ -172,45 +209,58 @@ Artifacts in the repository:
[[1]] Repository Purge By Number of Days Older
Using this criteria for the purge, Archiva will check how old an artifact is and if it is older than the set value in the
repository purge by days older field, then the artifact will be deleted respecting the retention count of course.
Using this criteria for the purge, Archiva will check how old an artifact is
and if it is older than the set value in the repository purge by days older
field, then the artifact will be deleted respecting the retention count of
course.
If repository purge by days older is set to 100 days (with repository purge by retention count field set to 1),
and the current date is let's say 03-01-2007, given the scenario above.. the following artifacts will be retained:
artifact-x-20070113.034619-3.jar, artifact-x-20070113.034619-3.pom, artifact-x-20070203.028902-4.jar and
artifact-x-20070203.028902-4.pom. It is clear in the version timestamps that these 4 artifacts are not more than
100 days old from the current date (which is 03-01-2007 in our example) so they are all retained. In this case
the retention count doesn't have any effect since the priority is the age of the artifact.
If repository purge by days older is set to 100 days (with repository purge by
retention count field set to 1), and the current date is let's say 03-01-2007,
given the scenario above.. the following artifacts will be retained:
artifact-x-20070113.034619-3.jar, artifact-x-20070113.034619-3.pom,
artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom. It is
clear in the version timestamps that these 4 artifacts are not more than 100
days old from the current date (which is 03-01-2007 in our example) so they are
all retained. In this case the retention count doesn't have any effect since the
priority is the age of the artifact.
Now, if the repository purge by days older is set to 30 days (with repository purge by retention count field still
set to 1) and the current date is still 03-01-2007, then given the same scenario above.. only the following artifacts
will be retained: artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom. In this case, we can see
that the retained artifacts are still not older by the number of days set in the repository purge by days older field
and the retention count is still met.
Now, if the repository purge by days older is set to 30 days (with repository
purge by retention count field still set to 1) and the current date is still
03-01-2007, then given the same scenario above.. only the following artifacts
will be retained: artifact-x-20070203.028902-4.jar and
artifact-x-20070203.028902-4.pom. In this case, we can see that the retained
artifacts are still not older by the number of days set in the repository purge
by days older field and the retention count is still met.
Now, let's set the repository purge by days older to 10 days (with repository purge by retention count field still
set to 1) and the current date is still 03-01-2007, then still given the same repository contents above.. the
following artifacts will still be retained: artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom.
It is clear from the version timestamps that the artifacts ARE MORE THAN the repository purge by days older value,
which is 10 days. Why is it still retained? Recall the value of the repository purge by retention count -- 1 :)
This ensures that there is ALWAYS 1 artifact timestamped version retained for every unique version snapshot directory
of an artifact.
Now, let's set the repository purge by days older to 10 days (with repository
purge by retention count field still set to 1) and the current date is still
03-01-2007, then still given the same repository contents above.. the following
artifacts will still be retained: artifact-x-20070203.028902-4.jar and
artifact-x-20070203.028902-4.pom. It is clear from the version timestamps that
the artifacts ARE MORE THAN the repository purge by days older value, which is
10 days. Why is it still retained? Recall the value of the repository purge by
retention count -- 1 :) This ensures that there is ALWAYS 1 artifact timestamped
version retained for every unique version snapshot directory of an artifact.
[[2]] Repository Purge By Retention Count
If the repository purge by retention count field is set to 2, then only the artifacts artifact-x-20070113.034619-3.jar,
artifact-x-20070113.034619-3.pom, artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom will be retained
in the repository. The oldest snapshots will be deleted maintaining only a number of snapshots equivalent to the set
retention count (regardless of how old or new the artifact is).
If the repository purge by retention count field is set to 2, then only the
artifacts artifact-x-20070113.034619-3.jar, artifact-x-20070113.034619-3.pom,
artifact-x-20070203.028902-4.jar and artifact-x-20070203.028902-4.pom will be
retained in the repository. The oldest snapshots will be deleted maintaining
only a number of snapshots equivalent to the set retention count (regardless of
how old or new the artifact is).
** Deleting Released Snapshots
You can also configure Archiva to clean up snapshot artifacts that have already been released. This can be done by ticking
the Delete Released Snapshots checkbox in the Repository Configuration form.
You can also configure Archiva to clean up snapshot artifacts that have
already been released. This can be done by ticking the Delete Released Snapshots
checkbox in the Repository Configuration form.
Once this feature is enabled, if Archiva encounters a snapshot artifact during repository scanning, it would check <<all>> the
repositories configured for a released version of that snapshot. If it finds one, then it would delete the entire
snapshot version directory.
Once this feature is enabled, if Archiva encounters a snapshot artifact during
repository scanning, it would check <<all>> the repositories configured for a
released version of that snapshot. If it finds one, then it would delete the
entire snapshot version directory.
It should be noted that this feature is entirely separate from the repository purge by number of days older and by
retention count.
It should be noted that this feature is entirely separate from the repository
purge by number of days older and by retention count.

1
archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/WEB-INF/web.xml
View File

@ -156,7 +156,6 @@
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>
<servlet>
<servlet-name>CXFServlet</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>

3
archiva-modules/archiva-web/archiva-webapp/src/main/webapp/WEB-INF/jsp/admin/proxyConnectors.jsp
View File

@ -66,8 +66,7 @@
<redback:ifAnyAuthorized permissions="archiva-manage-configuration">
<s:url id="addProxyConnectorUrl" action="addProxyConnector"/>
<s:a href="%{addProxyConnectorUrl}" cssClass="create">
<img src="<c:url value="/images/icons/create.png" />"/>
Add
<img src="<c:url value="/images/icons/create.png" />"/> Add
</s:a>
</redback:ifAnyAuthorized>
</c:when>

1
archiva-modules/archiva-web/archiva-webapp/src/main/webapp/WEB-INF/jsp/include/deleteArtifactForm.jspf
View File

@ -27,4 +27,3 @@
<s:textfield name="classifier" label="Classifier" size="60" required="false"/>
<s:textfield name="type" label="Type (mandatory when using classifier)" size="60" required="false" />
<s:select name="repositoryId" list="managedRepos" label="Repository Id"/>

5
archiva-modules/archiva-web/archiva-webapp/src/main/webapp/WEB-INF/jsp/include/uploadForm.jspf
View File

@ -28,10 +28,7 @@
<s:textfield name="version" label="Version" size="50" required="true"/>
<s:textfield name="packaging" label="Packaging" size="50" required="true"/>
<s:textfield name="classifier" label="Classifier" size="50" required="false"/>
<s:checkbox name="generatePom" value="generatePom"
label="Generate Maven 2 POM"/>
<s:checkbox name="generatePom" value="generatePom" label="Generate Maven 2 POM"/>
<s:file name="artifact" label="Artifact File" required="true"/>
<s:file name="pom" label="POM File"/>
<s:select name="repositoryId" list="managedRepoIdList" label="Repository Id"/>

39
archiva-modules/archiva-web/archiva-webapp/src/main/webapp/WEB-INF/jsp/reports/auditLogReport.jsp
View File

@ -54,49 +54,27 @@
<tr>
<td>Repository: </td>
<td><s:select name="repository" list="repositories" theme="simple"/></td>
<tr>
</tr>
<tr>
<td>Group ID: </td>
<td><s:textfield id="groupId" name="groupId" theme="simple"/></td>
<tr>
</tr>
<tr>
<td>Artifact ID: </td>
<td><s:textfield id="artifactId" name="artifactId" theme="simple"/></td>
<tr>
</tr>
<tr>
<td>Start Date: </td>
<td><s:textfield id="startDate" name="startDate" theme="simple"/>
<%--
<script type="text/javascript">
Calendar.setup({
inputField : "startDate",
ifFormat : "%Y-%m-%d",
align : "Tl",
singleClick : true
});
</script>
--%>
</td>
<tr>
<td><s:textfield id="startDate" name="startDate" theme="simple"/></td>
</tr>
<tr>
<td>End Date: </td>
<td><s:textfield id="endDate" name="endDate" theme="simple"/>
<%--
<script type="text/javascript">
Calendar.setup({
inputField : "endDate",
ifFormat : "%Y-%m-%d",
align : "Tl",
singleClick : true
});
</script>
--%>
</td>
<tr>
<td><s:textfield id="endDate" name="endDate" theme="simple"/></td>
</tr>
<tr>
<td>Row Count: </td>
<td><s:textfield name="rowCount" theme="simple"/></td>
<tr>
</tr>
<tr>
<td/>
<td style="text-align: right"><s:submit value="View Audit Log" theme="simple"/></td>
@ -169,7 +147,6 @@
</s:form>
</div>
</body>

1
archiva-modules/archiva-web/archiva-webapp/src/main/webapp/WEB-INF/jsp/reports/basicReport.jsp
View File

@ -36,7 +36,6 @@
<c:forEach var="repository" items="${repositoriesMap}">
<strong>Repository: ${repository.key}</strong>
<c:forEach var="report" items='${repository.value}'>
<p>
<archiva:groupIdLink var="${report.namespace}" includeTop="true"/>
<c:set var="url">