001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2014 ForgeRock AS. 015 */ 016 017package org.forgerock.openig.audit; 018 019import org.forgerock.openig.filter.Filter; 020import org.forgerock.openig.handler.Handler; 021 022/** 023 * Static list of standard tags used in audit decorators. 024 * String values not included in this set are considered 'user-defined' tags. 025 * <p> 026 * Notice that, when audit decorator developers are adding new tags, they have to keep this set of values in sync. 027 */ 028public enum Tag { 029 030 /** 031 * The event happens before the delegate {@link Filter}/{@link Handler} is called. 032 */ 033 request, 034 035 /** 036 * The event happens after the delegate {@link Filter}/{@link Handler} was called. 037 */ 038 response, 039 040 /** 041 * The event happens when the exchange has been completely handled <b>successfully</b> 042 * by the processing unit (always complements a {@link #response} tag). 043 */ 044 completed, 045 046 /** 047 * The event happens when the exchange has been handled with <b>errors</b> 048 * by the processing unit (always complements a {@link #response} tag). Notice that this does not indicate that 049 * the source heap object is the origin of the failure (it may or may not have thrown the exception itself). 050 */ 051 exception 052}