EventAuditingAttributeChangeListener (Keycloak Docs Distribution 21.0.2 API)

java.lang.Object
- org.keycloak.userprofile.EventAuditingAttributeChangeListener

All Implemented Interfaces:

AttributeChangeListener
```
public class EventAuditingAttributeChangeListener
extends Object
implements AttributeChangeListener
```
AttributeChangeListener to audit user profile attribute changes into Event. Adds info about user profile attribute change into Event's detail field.

Author:

Vlastimil Elias

See Also:

UserProfile.update(AttributeChangeListener...)

Constructor Summary

Constructors
Constructor Description

EventAuditingAttributeChangeListener(UserProfile profile, EventBuilder event)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`onChange(String attributeName, UserModel userModel, List<String> oldValue)`	Method called for each user attribute change.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EventAuditingAttributeChangeListener
```
public EventAuditingAttributeChangeListener(UserProfile profile,
                                            EventBuilder event)
```
    Parameters:
    
    profile - used to read attribute configuration from
    
    event - to add detail info into
- Method Detail
  - onChange
```
public void onChange(String attributeName,
                     UserModel userModel,
                     List<String> oldValue)
```
    Description copied from interface: AttributeChangeListener
    
    Method called for each user attribute change.
    
    Specified by:
    
    onChange in interface AttributeChangeListener
    
    Parameters:
    
    attributeName - of the changed user attribute
    
    userModel - model where new attribute value is applied already (can be null if attribute is removed)
    
    oldValue - of the attribute before the change (can be null)