org.eclipse.kura.audit

Enum AuditConstants

java.lang.Object

java.lang.Enum<AuditConstants>

org.eclipse.kura.audit.AuditConstants

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuditConstants>

@ProviderType
public enum AuditConstants
extends java.lang.Enum<AuditConstants>

Provides some well known audit context properties.

Since:

2.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENTRY_POINT_INTERNAL A value for the entrypoint that indicates a context created by an internal framework component and not associated with an external entity.
KEY_ENTRY_POINT Contains an identifier for the entry point associated with an audit context.
KEY_IDENTITY Reports the IP address of the Kura Identity associated with a request.
KEY_IP Reports the IP address of the device that performed a request.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static AuditConstants	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuditConstants[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KEY_ENTRY_POINT

public static final AuditConstants KEY_ENTRY_POINT

Contains an identifier for the entry point associated with an audit context. It must always be present.

KEY_IP

public static final AuditConstants KEY_IP

Reports the IP address of the device that performed a request. It can be missing.

KEY_IDENTITY

public static final AuditConstants KEY_IDENTITY

Reports the IP address of the Kura Identity associated with a request. It can be missing.

ENTRY_POINT_INTERNAL

public static final AuditConstants ENTRY_POINT_INTERNAL

A value for the entrypoint that indicates a context created by an internal framework component and not associated with an external entity.

Method Detail

values

public static AuditConstants[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuditConstants c : AuditConstants.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AuditConstants valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()