com.atlassian.confluence.impl.audit

Class AuditingContext

java.lang.Object

com.atlassian.confluence.impl.audit.AuditingContext

public final class AuditingContext
extends Object

Since:

7.5.0

Method Summary

Modifier and Type	Method and Description
static void	executeWithoutAuditing(Runnable operation) Executed operation with auditing being turned off for current thread
static AutoCloseable	noAuditing() This method provides convenient AutoCloseable, to use in try-with-resource expressions.
static AutoCloseable	noAuditing(String summaryKey) This method provides convenient AutoCloseable, to use in try-with-resource expressions.
static void	onlyAuditFor(String subjectKey, Runnable operation) Execute operation without auditing except for an event with given subjectKey
static boolean	skipAuditing() Returns true if auditing has to be skipped in current thread, false otherwise.
static boolean	skipAuditing(@Nullable String summaryKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

executeWithoutAuditing

public static void executeWithoutAuditing(Runnable operation)

Executed operation with auditing being turned off for current thread

Parameters:

operation - operation which doesn't have to be audited

onlyAuditFor

public static void onlyAuditFor(String subjectKey,
                                Runnable operation)

Execute operation without auditing except for an event with given subjectKey

Parameters:

subjectKey - Class of event to NOT skip auditing for.

operation - operation which doesn't have to be audited

noAuditing

public static AutoCloseable noAuditing()

This method provides convenient AutoCloseable, to use in try-with-resource expressions. For example try (AutoCloseable c = noAuditing()) { // operation, for which auditing has to be silenced copyPermissions(from, to); }

Returns:

convenient AutoCloseable, to use in try-with-resource expressions

noAuditing

public static AutoCloseable noAuditing(String summaryKey)

This method provides convenient AutoCloseable, to use in try-with-resource expressions. For example try (AutoCloseable c = noAuditing(event)) { // operation, for which auditing has to be silenced copyPermissions(from, to); }

Parameters:

summaryKey - the summary key to NOT skip auditing for

Returns:

convenient AutoCloseable, to use in try-with-resource expressions

skipAuditing

public static boolean skipAuditing()

Returns true if auditing has to be skipped in current thread, false otherwise.

Returns:

true if auditing has to be skipped in current thread, false otherwise.

skipAuditing

public static boolean skipAuditing(@Nullable String summaryKey)

Parameters:

summaryKey - if skipAuditing is true, but the this key matches the summary key, auditing will not be skipped. Returns true if auditing has to be skipped in current thread, false otherwise.

Returns:

true if auditing has to be skipped in current thread, false otherwise.