Package org.apereo.inspektr.audit.annotation

Annotation Interface Audit

@Retention(RUNTIME)
@Target(METHOD)
public @interface Audit

States that this method should be logged for auditing purposes.

Since:

1.0

Author:

Alice Leung, Dmitriy Kopylenko, Scott Battaglia

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	action	The action to write to the log when we audit this method.
String	actionResolverName	Reference name of the action resolver to use.
String	resourceResolverName	Reference name of the resource resolver to use.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	applicationCode	Identifier for this particular application in the audit trail logs.
String	principalResolverName	Reference name of the principal resolver to use.

Element Details

action

String action

The action to write to the log when we audit this method. Value must be defined.

Returns:

the action to write to the logs.

resourceResolverName

String resourceResolverName

Reference name of the resource resolver to use.

Returns:

the reference to the resource resolver. CANNOT be NULL.

actionResolverName

String actionResolverName

Reference name of the action resolver to use.

Returns:

the reference to the action resolver. CANNOT be NULL.

applicationCode

String applicationCode

Identifier for this particular application in the audit trail logs. This attribute should only be used to override the basic application code when you want to differentiate a section of the code.

Returns:

the application code or an empty String if none is set.

Default:

""

principalResolverName

String principalResolverName

Reference name of the principal resolver to use.

Returns:

the reference to the principal resolver.

Default:

""