Class AuditActor
java.lang.Object
com.inductiveautomation.ignition.common.audit.AuditActor
- Direct Known Subclasses:
AuditActor.ClassicUser, AuditActor.IdpUser, AuditActor.Unauthenticated, AuditActor.Unknown
public abstract sealed class AuditActor
extends Object
permits AuditActor.Unknown, AuditActor.Unauthenticated, AuditActor.ClassicUser, AuditActor.IdpUser
An actor for an audit record.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAn actor representing a user authenticated via a classic user source.static final classAn actor representing a user authenticated via an IdP.static final classAn actor representing an explicitly unauthenticated user.static final classAn actor representing an unknown user. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AuditActor.UnauthenticatedAn unauthenticated actor.static final AuditActor.UnknownAn unknown actor. -
Method Summary
Modifier and TypeMethodDescriptionstatic AuditActorforClassicUser(@Nullable String profileName, @Nullable String username) Create anAuditActorfor a user authenticated via a classic user source.static AuditActorforIdpUser(@Nullable String idpName, @Nullable String username) Create anAuditActorfor a user authenticated via an IdP.abstract StringtoString()
-
Field Details
-
UNKNOWN
An unknown actor. Use this actor when the user driving the action being audited is unknown. -
UNAUTHENTICATED
An unauthenticated actor. Use this actor when the user driving the action being audited is known to have not been authenticated.
-
-
Method Details
-
forIdpUser
Create anAuditActorfor a user authenticated via an IdP.If
usernameis null, returnsUNKNOWN. IfidpNameis null or blank, the resulting actor'stoString()will be the bare username.- Parameters:
idpName- the IdP the user authenticated with.username- the username of the authenticated user.- Returns:
- the
AuditActorinstance.
-
forClassicUser
Create anAuditActorfor a user authenticated via a classic user source.If
usernameis null, returnsUNKNOWN. IfprofileNameis null or blank, the resulting actor'stoString()will be the bare username.- Parameters:
profileName- the user source the user authenticated against.username- the username of the authenticated user.- Returns:
- the
AuditActorinstance.
-
toString
-