org.apereo.inspektr.audit.annotation

Annotation Type Audit

@Retention(value=RUNTIME)
 @Target(value=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 and Description
java.lang.String	action The action to write to the log when we audit this method.
java.lang.String	actionResolverName Reference name of the action resolver to use.
java.lang.String	resourceResolverName Reference name of the resource resolver to use.

Optional Element Summary

Optional Elements

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

Element Detail

action

public abstract java.lang.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

public abstract java.lang.String resourceResolverName

Reference name of the resource resolver to use.

Returns:

the reference to the resource resolver. CANNOT be NULL.

actionResolverName

public abstract java.lang.String actionResolverName

Reference name of the action resolver to use.

Returns:

the reference to the action resolver. CANNOT be NULL.

applicationCode

public abstract java.lang.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

public abstract java.lang.String principalResolverName

Reference name of the principal resolver to use.

Returns:

the reference to the principal resolver.

Default:

""