Audit Log Report

From: Maria Odea B. Ching Date: Mon, 11 Jan 2010 15:07:00 +0000 (+0000) Subject: [MRM-1296] Audit logging report X-Git-Tag: archiva-1.3~13 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=b44ad982c3afa5a3f34c4fd682eea9b2925e7898;p=archiva.git [MRM-1296] Audit logging report merged MRM-1296 branch to trunk git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@897892 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/archiva-docs/src/site/apt/userguide/auditlog-report.apt b/archiva-docs/src/site/apt/userguide/auditlog-report.apt new file mode 100644 index 000000000..c2eb93cbe --- /dev/null +++ b/archiva-docs/src/site/apt/userguide/auditlog-report.apt @@ -0,0 +1,38 @@ + ------ + Audit Log Report + ------ + +Audit Log Report + + Starting with Archiva 1.3, audit events can be viewed and queried from the web UI. In the current implementation, only artifact upload events are viewable + but there are plans to include other events such as artifact delete, repository creation and deletion, configuration changes, etc. + + To view the audit events, click <<>> from the navigation menu. Initially, the latest 10 artifact upload events are displayed. + +[../images/latest-events.png] Latest Events + +* Customizing the Audit Log Report + + The following fields can be specified when querying for the audit events: + + [[1]] Repository - the repository where the events happened. Only those repositories which the logged in user has permission to access are listed in the drop-down + box. + + [[2]] Group ID - the <<>> of the artifact whose audit events you want to view. + + [[3]] Artifact ID - the <<>> of the artifact whose audit events you want to view. + + [[4]] Start Date - the start date of the event(s) you want to view. This defaults to the current date if none is specified. + + [[5]] End Date - the end date of the event(s) you want to view. This defaults to the current date if none is specified. + + [[6]] Row Count - the number of rows you want displayed per page. This will be the basis for the pagination of the results. The default value is 30 rows. + + [] + + Just specify values for either one or all of the above fields and then submit the form to perform the query. The results of the query will be displayed at the lower + section of the page, similar to that shown in the <<>> except that the heading will be <<>> instead of <<>>. + + + + diff --git a/archiva-docs/src/site/apt/userguide/index.apt b/archiva-docs/src/site/apt/userguide/index.apt index d79e6eb3d..4227e8f46 100644 --- a/archiva-docs/src/site/apt/userguide/index.apt +++ b/archiva-docs/src/site/apt/userguide/index.apt @@ -20,6 +20,8 @@ Users Guide * {{{virtual-repositories.html} Configuring Virtual Repositories}} * {{{rss.html}RSS Feeds in Archiva}} + + * {{{auditlog-report.html}Viewing the Audit Log Report}} [] diff --git a/archiva-docs/src/site/resources/images/latest-events.png b/archiva-docs/src/site/resources/images/latest-events.png new file mode 100644 index 000000000..823234031 Binary files /dev/null and b/archiva-docs/src/site/resources/images/latest-events.png differ diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml index ca9eb0e0f..9c6650c2a 100644 --- a/archiva-docs/src/site/site.xml +++ b/archiva-docs/src/site/site.xml @@ -40,6 +40,7 @@ + diff --git a/archiva-modules/archiva-base/archiva-model/pom.xml b/archiva-modules/archiva-base/archiva-model/pom.xml index f686016c9..f24fd3724 100755 --- a/archiva-modules/archiva-base/archiva-model/pom.xml +++ b/archiva-modules/archiva-base/archiva-model/pom.xml @@ -70,7 +70,7 @@ org.codehaus.modello modello-maven-plugin - 1.2.1 + 1.3.0 false src/main/mdo/archiva-base.xml diff --git a/archiva-modules/archiva-base/archiva-model/src/main/mdo/archiva-base.xml b/archiva-modules/archiva-base/archiva-model/src/main/mdo/archiva-base.xml index de08a8d7b..93e4a295a 100644 --- a/archiva-modules/archiva-base/archiva-model/src/main/mdo/archiva-base.xml +++ b/archiva-modules/archiva-base/archiva-model/src/main/mdo/archiva-base.xml @@ -5,7 +5,7 @@ xsd.target-namespace="http://archiva.apache.org/model/1.2.0"> archiva-base-model ArchivaBaseModel - 1.2.1 + 1.3.0 Archiva Model @@ -75,6 +75,14 @@ * + + archivaAuditLogs + 1.3.0+ + + ArchivaAuditLogs + * + + @@ -2278,5 +2286,70 @@ + + ArchivaAuditLogs + 1.3.0+ + + + repositoryId + 1.3.0+ + false + true + String + + The repository id where the operation was done. + + + + eventDate + 1.3.0+ + false + true + Date + + The timestamp on when the event happened. + + + + artifact + 1.3.0+ + false + false + String + + The affected artifact, if there is one. + + + + event + 1.3.0+ + false + false + String + + The event that happened. + + + + username + 1.3.0+ + false + true + String + + The user who executed the event. + + + + + + 1.3.0+ + + + + diff --git a/archiva-modules/archiva-database/src/main/java/org/apache/maven/archiva/database/ArchivaAuditLogsDao.java b/archiva-modules/archiva-database/src/main/java/org/apache/maven/archiva/database/ArchivaAuditLogsDao.java new file mode 100644 index 000000000..639c5d623 --- /dev/null +++ b/archiva-modules/archiva-database/src/main/java/org/apache/maven/archiva/database/ArchivaAuditLogsDao.java @@ -0,0 +1,35 @@ +package org.apache.maven.archiva.database; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import java.util.List; + +import org.apache.maven.archiva.model.ArchivaAuditLogs; + +public interface ArchivaAuditLogsDao +{ + public List queryAuditLogs( Constraint constraint ) + throws ObjectNotFoundException, ArchivaDatabaseException; + + public ArchivaAuditLogs saveAuditLogs( ArchivaAuditLogs logs ); + + public void deleteAuditLogs( ArchivaAuditLogs logs ) + throws ArchivaDatabaseException; +} diff --git a/archiva-modules/archiva-database/src/main/java/org/apache/maven/archiva/database/constraints/ArchivaAuditLogsConstraint.java b/archiva-modules/archiva-database/src/main/java/org/apache/maven/archiva/database/constraints/ArchivaAuditLogsConstraint.java new file mode 100644 index 000000000..ed225ae6f --- /dev/null +++ b/archiva-modules/archiva-database/src/main/java/org/apache/maven/archiva/database/constraints/ArchivaAuditLogsConstraint.java @@ -0,0 +1,106 @@ +package org.apache.maven.archiva.database.constraints; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * ArchivaAuditLogsConstraint + */ +public class ArchivaAuditLogsConstraint + extends RangeConstraint +{ + private String whereClause; + + private void createWhereClause( String desiredArtifact, String desiredRepositoryId, String desiredEvent, + Date startDate, Date endDate ) + { + whereClause = "eventDate >= desiredStartDate && eventDate <= desiredEndDate"; + declImports = new String[] { "import java.util.Date" }; + + List declParamsList = new ArrayList(); + declParamsList.add( "Date desiredStartDate" ); + declParamsList.add( "Date desiredEndDate" ); + + List

Repository:
Group ID:
Artifact ID:
Start Date:	+ <%-- + + --%> +
End Date:	+ <%-- + + --%> +
Row Count:
+

Manage

Audit Log Report

${headerName}