Repository: syncope Updated Branches: refs/heads/master a164f8edf -> e4e7268ae
[SYNCOPE-700] Audit Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/e4e7268a Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/e4e7268a Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/e4e7268a Branch: refs/heads/master Commit: e4e7268ae5e27b919b6904cd623a06b654f48148 Parents: a164f8e Author: Francesco Chicchiriccò <[email protected]> Authored: Thu Aug 18 16:07:21 2016 +0200 Committer: Francesco Chicchiriccò <[email protected]> Committed: Thu Aug 18 16:07:21 2016 +0200 ---------------------------------------------------------------------- .../reference-guide/concepts/audit.adoc | 35 ++++++++++++++++++++ .../reference-guide/concepts/concepts.adoc | 4 +-- .../reference-guide/concepts/notifications.adoc | 2 +- 3 files changed, 37 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/e4e7268a/src/main/asciidoc/reference-guide/concepts/audit.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/audit.adoc b/src/main/asciidoc/reference-guide/concepts/audit.adoc new file mode 100644 index 0000000..011ab35 --- /dev/null +++ b/src/main/asciidoc/reference-guide/concepts/audit.adoc @@ -0,0 +1,35 @@ +// +// 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. +// + +=== Audit + +The audit feature allows to capture <<audit-events,events>> occuring within the <<core>> and to log relevant information +about them as entries into the `SYNCOPEAUDIT` table of the internal storage. + +Once events are reported in the table above, they can be used as input for external tools. + +[TIP] +==== +An example of how audit entries can be extracted for reporting is shown by the <<audit-reportlet>>. +==== + +==== Audit Events + +What described for <<notification-events,notification events>> is also valid for audit events, examples included - +except for admin console <<console-configuration-audit,tooling>>, which is naturally distinct. http://git-wip-us.apache.org/repos/asf/syncope/blob/e4e7268a/src/main/asciidoc/reference-guide/concepts/concepts.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/concepts.adoc b/src/main/asciidoc/reference-guide/concepts/concepts.adoc index 29211a0..6edfc52 100644 --- a/src/main/asciidoc/reference-guide/concepts/concepts.adoc +++ b/src/main/asciidoc/reference-guide/concepts/concepts.adoc @@ -42,8 +42,6 @@ include::tasks.adoc[] include::reports.adoc[] -=== Audit - -==== Audit Events +include::audit.adoc[] === Domains http://git-wip-us.apache.org/repos/asf/syncope/blob/e4e7268a/src/main/asciidoc/reference-guide/concepts/notifications.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/concepts/notifications.adoc b/src/main/asciidoc/reference-guide/concepts/notifications.adoc index 4e20160..2646603 100644 --- a/src/main/asciidoc/reference-guide/concepts/notifications.adoc +++ b/src/main/asciidoc/reference-guide/concepts/notifications.adoc @@ -52,7 +52,7 @@ of the generated <<tasks-notification,notification tasks>> ==== Notification Events Notification (and <<audit-events,Audit>>) events are essentially a mean to identify the invocation of specific methods -within the Apache Syncope <<core>>, in line with _join points_ in the +within the <<core>>, in line with _join points_ in the https://en.wikipedia.org/wiki/Aspect-oriented_programming[Aspect Oriented Programming (AOP)^]. An event is identified by the following five coordinates:
