org.eclipse.kura.audit

Class AuditContext

java.lang.Object

org.eclipse.kura.audit.AuditContext

@ProviderType
public class AuditContext
extends java.lang.Object

Represents a context that can be created by a framework entry point for audit purposes. Examples of entry points are the Web UI, a cloud connection or the Rest service. An AuditContext contains a set of properties. Some property are well known and described by the AuditConstants enumeration, other custom properties can be added by the entry point implementation.

Since:

2.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditContext.Scope Resents an AutoCloseable scope that removes the associated AuditContext when closed.

Constructor Summary

Constructors

Constructor and Description
AuditContext(java.util.Map<java.lang.String,java.lang.String> properties) Creates a new AuditContext.

Method Summary

Modifier and Type	Method and Description
AuditContext	copy() Creates a copy of this AuditContext with a new and independent set of properties.
static java.util.Optional<AuditContext>	current() Returns the AuditContext associated with the current thread, if any.
static AuditContext	currentOrInternal() Returns the AuditContext associated with the current thread, if set, or a context with AuditConstants.KEY_ENTRY_POINT set to AuditConstants.ENTRY_POINT_INTERNAL otherwise.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns the properties associated with this context
static AuditContext.Scope	openScope(AuditContext context) Sets the provided context as the thread local instance and returns a AuditContext.Scope that can be used for removing it.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditContext

public AuditContext(java.util.Map<java.lang.String,java.lang.String> properties)

Creates a new AuditContext.

Parameters:

properties - The properties to be associated with this context. It must be a non null mutable map.

Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns the properties associated with this context

Returns:

the properties.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public AuditContext copy()

Creates a copy of this AuditContext with a new and independent set of properties.

Returns:

a copy of this AuditContext.

currentOrInternal

public static AuditContext currentOrInternal()

Returns the AuditContext associated with the current thread, if set, or a context with AuditConstants.KEY_ENTRY_POINT set to AuditConstants.ENTRY_POINT_INTERNAL otherwise.

Returns:

the AuditContext

current

public static java.util.Optional<AuditContext> current()

Returns the AuditContext associated with the current thread, if any.

Returns:

the AuditContext associated with this thread or empty if none is set

openScope

public static AuditContext.Scope openScope(AuditContext context)

Sets the provided context as the thread local instance and returns a AuditContext.Scope that can be used for removing it. Subsequent calls to currentOrInternal() performed on the same thread will return the provided AuditContext instance until the returned AuditContext.Scope is closed.

Parameters:

context - the context

Returns:

a AuditContext.Scope that removes the thread local context when closed.