Class AuthenticationAccessAuditFilter
- java.lang.Object
-
- org.forgerock.openam.audit.AbstractHttpAccessAuditFilter
-
- org.forgerock.openam.core.rest.authn.AuthenticationAccessAuditFilter
-
- All Implemented Interfaces:
org.forgerock.http.Filter
public class AuthenticationAccessAuditFilter extends AbstractHttpAccessAuditFilter
Responsible for logging access audit events for authentication requests.- Since:
- 13.0.0
-
-
Constructor Summary
Constructors Constructor Description AuthenticationAccessAuditFilter(AuthIdHelper authIdHelper, AuditEventPublisher auditEventPublisher, AuditEventFactory auditEventFactory)Create a new filter for the given component and restlet.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringgetRealm(org.forgerock.services.context.Context context)Get the realm from the request context.protected Set<String>getTrackingIdsForAccessAttempt(org.forgerock.http.protocol.Request request)Retrieve the tracking IDs for an access attempt.protected Set<String>getTrackingIdsForAccessOutcome(org.forgerock.http.protocol.Response response)Retrieve the tracking IDs for an access outcome.protected StringgetUserIdForAccessOutcome(org.forgerock.http.protocol.Response response)Retrieve the user ID for an access outcome.-
Methods inherited from class org.forgerock.openam.audit.AbstractHttpAccessAuditFilter
filter, getUserIdForAccessAttempt
-
-
-
-
Constructor Detail
-
AuthenticationAccessAuditFilter
@Inject public AuthenticationAccessAuditFilter(AuthIdHelper authIdHelper, AuditEventPublisher auditEventPublisher, AuditEventFactory auditEventFactory)
Create a new filter for the given component and restlet.- Parameters:
authIdHelper- The helper to use for reading authentication JWTs.auditEventPublisher- The publisher responsible for logging the events.auditEventFactory- The factory that can be used to create the events.
-
-
Method Detail
-
getTrackingIdsForAccessAttempt
protected Set<String> getTrackingIdsForAccessAttempt(org.forgerock.http.protocol.Request request)
Description copied from class:AbstractHttpAccessAuditFilterRetrieve the tracking IDs for an access attempt.- Overrides:
getTrackingIdsForAccessAttemptin classAbstractHttpAccessAuditFilter- Parameters:
request- the restlet request- Returns:
- the tracking IDs
-
getUserIdForAccessOutcome
protected String getUserIdForAccessOutcome(org.forgerock.http.protocol.Response response)
Description copied from class:AbstractHttpAccessAuditFilterRetrieve the user ID for an access outcome.- Overrides:
getUserIdForAccessOutcomein classAbstractHttpAccessAuditFilter- Parameters:
response- the restlet response- Returns:
- the user ID
-
getTrackingIdsForAccessOutcome
protected Set<String> getTrackingIdsForAccessOutcome(org.forgerock.http.protocol.Response response)
Description copied from class:AbstractHttpAccessAuditFilterRetrieve the tracking IDs for an access outcome.- Overrides:
getTrackingIdsForAccessOutcomein classAbstractHttpAccessAuditFilter- Parameters:
response- the restlet response- Returns:
- the tracking IDs
-
getRealm
protected String getRealm(org.forgerock.services.context.Context context)
Description copied from class:AbstractHttpAccessAuditFilterGet the realm from the request context. If the realm is eithernullor empty the event will be published to the default audit service.- Specified by:
getRealmin classAbstractHttpAccessAuditFilter- Parameters:
context- The request context.- Returns:
- The realm.
-
-