io.helidon.security.annot

Annotation Type Audited

@Retention(value=RUNTIME)
@Target(value={METHOD,TYPE,FIELD})
@Documented
@Inherited
public @interface Audited

An annotation to specify server resources to be audited.

Field Summary

Fields

Modifier and Type	Fields and Description
static AuditEvent.AuditSeverity	DEFAULT_ERROR_SEVERITY Default severity for non-OK statuses.
static java.lang.String	DEFAULT_EVENT_TYPE Default event type: "request".
static java.lang.String	DEFAULT_MESSAGE_FORMAT Default message format: "%3$s %1$s \"%2$s\" %5$s %6$s requested by %4$s".
static AuditEvent.AuditSeverity	DEFAULT_OK_SEVERITY Default severity for OK status.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AuditEvent.AuditSeverity	errorSeverity Severity of request with unsuccessful response (in http, this would be 4** and 5** status).
java.lang.String	messageFormat The message format of this audit event.
AuditEvent.AuditSeverity	okSeverity Severity of request with successful response (in http, this would be 1** 2** and 3** statuses).
java.lang.String	value Event type of this audit event.

Field Detail

DEFAULT_EVENT_TYPE

public static final java.lang.String DEFAULT_EVENT_TYPE

Default event type: "request".

DEFAULT_MESSAGE_FORMAT

public static final java.lang.String DEFAULT_MESSAGE_FORMAT

Default message format: "%3$s %1$s \"%2$s\" %5$s %6$s requested by %4$s". The output is: <STATUS> <METHOD> <PATH> <TRANSPORT> <RESOURCE_TYPE> requested by <SUBJECT>

DEFAULT_OK_SEVERITY

public static final AuditEvent.AuditSeverity DEFAULT_OK_SEVERITY

Default severity for OK status.

DEFAULT_ERROR_SEVERITY

public static final AuditEvent.AuditSeverity DEFAULT_ERROR_SEVERITY

Default severity for non-OK statuses.

Element Detail

value

public abstract java.lang.String value

Event type of this audit event.

Returns:

event type, defaults to "request"

Default:

"request"

messageFormat

public abstract java.lang.String messageFormat

The message format of this audit event. The following parameters will be provided (in order):

• method: method requested (GET, POST for http)
• path: the requested path (optional)
• status: status code/status string (depends on protocol and integrated framework)
• subject: current security subject
• transport: transport (such as http)
• resourceType: resource type requested (optional)
• targetUri: full uri (as available, optional)

Returns:

message format to create message to be audited

Default:

"%3$s %1$s \"%2$s\" %5$s %6$s requested by %4$s"

okSeverity

public abstract AuditEvent.AuditSeverity okSeverity

Severity of request with successful response (in http, this would be 1** 2** and 3** statuses).

Returns:

severity to use

Default:

io.helidon.security.AuditEvent.AuditSeverity.SUCCESS

errorSeverity

public abstract AuditEvent.AuditSeverity errorSeverity

Severity of request with unsuccessful response (in http, this would be 4** and 5** status).

Returns:

severity to use

Default:

io.helidon.security.AuditEvent.AuditSeverity.FAILURE