AuditEvent.AuditParam (Helidon 1.4.12 API)

java.lang.Object
- io.helidon.security.AuditEvent.AuditParam

Enclosing interface:

AuditEvent
```
public static final class AuditEvent.AuditParam
extends Object
```
Named parameters of audit event. If sensitive, the audit provider should either encrypt them or obfuscate them.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isSensitive()`	Whether this is sensitive information (such as passwords).
`String`	`name()`	Name of this parameter.
`static AuditEvent.AuditParam`	`plain(String name, Object parameter)`	New parameter of any type.
`static AuditEvent.AuditParam`	`sensitive(String name, Object parameter)`	New parameter of any type that is sensitive.
`String`	`toString()`
`Optional<Object>`	`value()`	Value of this parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - plain
```
public static AuditEvent.AuditParam plain(String name,
                                          Object parameter)
```
    New parameter of any type.
    
    Parameters:
    
    name - parameter name
    
    parameter - parameter value
    
    Returns:
    
    Plain audit parameter
  - sensitive
```
public static AuditEvent.AuditParam sensitive(String name,
                                              Object parameter)
```
    New parameter of any type that is sensitive.
    
    Parameters:
    
    name - parameter name
    
    parameter - parameter value
    
    Returns:
    
    Sensitive audit parameter
  - name
```
public String name()
```
    Name of this parameter.
    
    Returns:
    
    name
  - value
```
public Optional<Object> value()
```
    Value of this parameter.
    
    Returns:
    
    value or empty if not defined (null).
  - isSensitive
```
public boolean isSensitive()
```
    Whether this is sensitive information (such as passwords). Handle sensitive information carefully - e.g. do not log it.
    
    Returns:
    
    true if this is a sensitive value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object