Package ch.tocco.nice2.persist.core.api.util

Class CollectingEntityListener

java.lang.Object

ch.tocco.nice2.persist.core.api.util.CollectingEntityListener

All Implemented Interfaces:

ContextListener, EntityFacadeListener, CommitListener, EventListener

Direct Known Subclasses:

AbstractContactCreateListener, AccountEntityListener, ActiveVatRateEntityListener, AddressDebitorInformationEntityListener, AliasNormalizerEntityListener, ArchivedUserEntityListener, ArticlePriceSortingEntityListener, AvailabilityCalendarFieldsListener, BatchJobEntityListener, BillingPositionCheckEntityListener, BillingPositionEntityCheckEntityListener, BirthdateSortingEntityListener, CalculateActualPointsEntityListener, CalculateAmountEntityListener, CalculateMaxPointsEntityListener, CalculateNumberOfReservationsEntityListener, CalendarEventLabelUpdateListener, CampaignActualValuesEntityListener, CampaignEffortEntityListener, CaseBillingPositionEntityListener, ChildFunctionListener, ClearGeoLocationListener, ClientCacheInvalidationListener, ContactAddressEntityListener, ContractCreateEntityListener, ContractDateDeleteEntityListener, ContractValidityDateEntityListener, CopyBillingPositionEntityListener, CopyDocumentsToEntityDocsListener, CopyEducationalSchedulesToEventListener, CopyPathEntityListener, CorrespondenceContactUpdateEntityListener, CostCenterEntityListener, CountEntitiesListener, CourseOfStudyEntityListener, CreateCalendarExportListener, CreateEvaluationAnswersEntityListener, CreateOnlinepaymentOrderListener, CreditRatingEntityListener, CustomerContractBillingPositionEntityListener, DebitorCreationEntityListener, DefaultReportRecipientFlagEntityListener, DefaultUserInvoicedEntityListener, DeleteMovementEntityListener, DeleteMovementWithArticleEntityListener, DonationContactEntityListener, EffortFieldUpdateEntityListener, EffortProjectionEntityListener, EffortTimereportEntityListener, EmailArchiveTypeEntityListener, EnsureNoVoucherForFinancialYearEntityListener, EntityCalendarEventListener, EntityDocumentsPropagateRelationEntityListener, EntityHistoryDeletionEntityListener, EntityTemplateCreateEntityListener, EvaluationEntityListener, EventCancellationEntityListener, EventCostsCalculatorEntityListener, EventIsTemplateEntityListener, EventPeriodEntityListener, EventPropagationEntityListener, EventRequirementEntityListener, EventSeminarRelationEntityListener, EventStatusEntityListener, ExpenseCalculateCostEntityListener, FlipUserSalutationEntityListener, FunctionMutationEntityListener, GenerateRegistrationUuidEntityListener, GenericCalendarEventListener, InitNodeRightsEntityListener, InputEntityListener, InvalidateCmsTemplateCacheListener, LecturerBookingPropagationEntityListener, LecturerBookingTotalLessonsEntityListener, LecturerBookingUserUpdateListener, LicenceBillingPositionEntityListener, LicenceEntityListener, LinkedAnswerOptionEntityListener, LinkedQuestionEntityListener, MembershipBillingPositionEntityListener, MembershipUserAnswerEntityListener, MinimalPresenceDeleteEntityListener, MovementArticleEntityListener, MovementBillingPositionEntityListener, OfftimeEventMappingEntityListener, OneStandardValueEntityListener, OrderBillPrintedCheckEntityListener, OrderBillPrintedEntityListener, OrderDeletionEntityListener, OrderOrderRateEntityListener, OrderPositionDiscountEntityListener, OrderPositionPriceChangeEntityListener, OrderPositionSortingEntityListener, OrderPriceRecalculationEntityListener, OrderRateFeeEntityListener, OrderTextsEntityListener, PrepaymentStatusEntityListener, PrepaymentVoucherEntityListener, PrincipalEntityListener, PrincipalSessionEntityListener, PromotionCodeEntityListener, PromotionDataRegistrationListener, QualificationRegistrationInformationListener, QuestionnaireFixationEntityListener, RefreshOrderTotalsEntityListener, RegistrationEntityListener, RegistrationPropagationEntityListener, RegistrationRequirementEntityListener, RegistrationSetEntityListener, RegistrationStatusRelevantForGradeEntityListener, ReplaceBinaryEntityListener, RequirementAccomplishmentListener, RequirementCheckDateEntityListener, RequirementPackageEntityListener, RequirementRuleCheckEntityListener, ReservationCountEntityListener, ReservationPropagationEntityListener, ReservationRegistrationCountEntityListener, ReservationRegistrationEntityListener, ResetConflictsStatusListener, SchoolingRegistrationEntityListener, ScriptEntityFacadeListener, SeminarPeriodCountEntityListener, SetAddressFieldsEntityListener, SetBusinessUnitListener, SetChildrenFlagListener, SetDefaultSalaryOnLecturerBookingEntityListener, SetEventArchivedEnityListener, SetEventPublicationDateEntityListener, SetInputDataRegistrationListener, SetMembershipTypeRelationsEntityListener, SetMergedOutputJobsStatusEntityListener, SetStatusDateEntityListener, SetUnbalancedPrepaymentFlagEntityListener, SmsContactCreatorEntityListener, SummarizeMaxPointsEntityListener, SurveyIntrusionEntityListener, SurveyUserIntrusionEntityListener, TermsConditionConfirmationSourceListener, ThresholdValueEntityListener, TimereportRecordEntityListener, TimereportSchemeDayEntityListener, TopicEntityListener, TransferCantonFromUserToSchoolingEntityListener, UniqueOrderTemplateListener, UpdateAddressBlockEntityListener, UpdateContingentOnMovementEntityListener, UpdateEventConnectionTypeListener, UpdateHierarchyListener, UpdateLoginEntityListener, UpdateOpenBalanceDueEntityListener, UpdatePagePositionEntityListener, UpdateReferencesListener, UpdateSectionPositionListener, UpdateUrlIndexListener, UpdateWidgetRecordListener, VoucherChangedEntityListener, VoucherStornoDebitorEntityListener, WidgetConfigUpdateListener, WidgetDomainSecretListener, ZipFieldsUpdateEntityListener

public abstract class CollectingEntityListener
extends Object
implements EntityFacadeListener, CommitListener, ContextListener

EntityFacadeListener that collects facade events up until the current transaction is about to be committed. Every EntityFacadeEvent that comes in after the berfore-commit is discarded. This especially applies to all EntityFacadeEvents that are generated due to this listener.

Subclasses can listen for the before-commit event by implementing the onBeforeCommit(Transaction) method. At this point the entities that have been created and/or updated are available via getAffectedEntities() (and some filtering methods like getCreatedEntities()). Additional data to each entity can be retrieved via getOldValues(Entity) and getRelationChanges(Entity)

Note, this listener must be registered with the @ThreadScope annotation and the @Listener(filter = "Resource") annotation to define the filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectingEntityListener.EntityModelNamePredicate	Predicate to filter entities by entity model name.
static class	CollectingEntityListener.FieldTouchedPredicate	Predicate to filter entities which have at least one of the given fields touched.
static class	CollectingEntityListener.RelationTouchedPredicate	Predicate to filter entities which have a certain relation touched.

Constructor Summary

Constructors

Constructor	Description
CollectingEntityListener()

Method Summary

Modifier and Type	Method	Description
void	afterCommit(Context context)	Notifies about the point where the transaction has been fully committed.
void	beforeCommit(Transaction tx)	Notifies about the point where the transaction is about to be committed.
final void	contextDestroying(ContextEvent event)
final void	entityChanging(EntityChangedEvent event)	Fired when any changes are made to an entity.
final void	entityCreating(EntityFacadeEvent event)	Fired when an entity is being created.
final void	entityDeleting(EntityFacadeEvent event)	Fired when an entity is being deleted.
static CollectingEntityListener.EntityModelNamePredicate	entityModel(String entityModelName)	Create a CollectingEntityListener.EntityModelNamePredicate.
final void	entityRelationChanging(EntityRelationChangedEvent event)	Fired when a relation of an entity has been changed.
static CollectingEntityListener.FieldTouchedPredicate	fieldTouched(String... fieldNames)	Create a CollectingEntityListener.FieldTouchedPredicate.
static CollectingEntityListener.FieldTouchedPredicate	fieldTouched(Collection<String> fieldNames)	Create a CollectingEntityListener.FieldTouchedPredicate.
List<EntityRelationChangedEvent>	getAddedRelationChanges(Entity e)
List<EntityRelationChangedEvent>	getAddedRelationChangesFor(Entity e, String relationName)
List<Entity>	getAffectedEntities()	Get all entities that have been created or updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getAffectedEntities(Predicate<Entity> predicate)	Get all entities that have been created or updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getAllAffectedEntities()	Get all entities that have been affected in any way (created, updated or deleted) during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getAllAffectedEntities(Predicate<Entity> predicate)	Get all entities that have been affected in any way (created, updated or deleted) during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<EntityRelationChangedEvent>	getAllRelationChanges()
List<Entity>	getCreatedEntities()	Get all entities that have been created during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getCreatedEntities(Predicate<Entity> predicate)	Get all entities that have been created during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getDeletedEntities()	Get all entities that have been created or updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getDeletedEntities(Predicate<Entity> predicate)	Get all entities that have been deleted during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
protected Object	getKey(Entity entity)
Map<String,Object>	getOldValues(Entity e)
List<EntityRelationChangedEvent>	getRelationChanges(Entity e)
List<EntityRelationChangedEvent>	getRelationChangesFor(Entity e, String... relationNames)
List<EntityRelationChangedEvent>	getRelationChangesFor(Entity e, Collection<String> relationNames)
List<EntityRelationChangedEvent>	getRemovedRelationChanges(Entity e)
List<EntityRelationChangedEvent>	getRemovedRelationChangesFor(Entity e, String relationName)
List<Entity>	getUpdatedEntities()	Get all entities that have been updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.
List<Entity>	getUpdatedEntities(Predicate<Entity> predicate)	Get the updated entities.
protected boolean	isValidTx(EntityFacadeEvent event)
abstract void	onBeforeCommit(Transaction tx)
protected void	onEntityChanging(EntityChangedEvent event)
protected void	onEntityCreating(EntityFacadeEvent event)
protected void	onEntityDeleting(EntityFacadeEvent event)
protected void	onEntityRelationChanging(EntityRelationChangedEvent event)
static CollectingEntityListener.RelationTouchedPredicate	relationTouched(String... relationNames)	Create a CollectingEntityListener.RelationTouchedPredicate.
static CollectingEntityListener.RelationTouchedPredicate	relationTouched(Collection<String> relationNames)	Create a CollectingEntityListener.RelationTouchedPredicate.
void	transactionStarted(TransactionStartedEvent event)
void	withAffectedEntities(Consumer<Entity> consumer)	Do something with the entities that have been created or updated during the transaction
void	withAffectedEntities(Consumer<Entity> consumer, Predicate<Entity> predicate)	Do something with the entities that have been created or updated during the transaction
void	withAllAffectedEntities(Consumer<Entity> consumer)	Do something with the entities that have been affected in any way (created, updated or deleted) during the transaction
void	withAllAffectedEntities(Consumer<Entity> consumer, Predicate<Entity> predicate)	Do something with the entities that have been affected in any way (created, updated or deleted) during the transaction
void	withCreatedEntities(Consumer<Entity> consumer)	Do something with the entities that have been created during the transaction
void	withCreatedEntities(Consumer<Entity> consumer, Predicate<Entity> predicate)	Do something with the entities that have been created during the transaction
void	withDeletedEntities(Consumer<Entity> consumer)	Do something with the entities that have been updated during the transaction
void	withDeletedEntities(Consumer<Entity> consumer, Predicate<Entity> predicate)	Do something with the entities that have been deleted during the transaction
void	withUpdatedEntities(Consumer<Entity> consumer)	Do something with the entities that have been updated during the transaction
void	withUpdatedEntities(Consumer<Entity> consumer, Predicate<Entity> predicate)	Do something with the entities that have been updated during the transaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.tocco.nice2.persist.core.api.util.CommitListener

afterFlush, priority

Methods inherited from interface ch.tocco.nice2.persist.core.api.entity.events.EntityFacadeListener

entityReceivedValues, handleSessionOnlyEntity

Constructor Details

CollectingEntityListener

public CollectingEntityListener()

Method Details

beforeCommit

public void beforeCommit(Transaction tx)

Description copied from interface: CommitListener

Notifies about the point where the transaction is about to be committed.

This allows further modification of involved entities.

Specified by:

beforeCommit in interface CommitListener

Parameters:

tx - the transaction in question

onBeforeCommit

public abstract void onBeforeCommit(Transaction tx)

getKey

protected Object getKey(Entity entity)

afterCommit

public void afterCommit(Context context)

Description copied from interface: CommitListener

Notifies about the point where the transaction has been fully committed.

This allows post processing of the entities involved in the previous commit.

Specified by:

afterCommit in interface CommitListener

withAllAffectedEntities

public void withAllAffectedEntities(Consumer<Entity> consumer)

Do something with the entities that have been affected in any way (created, updated or deleted) during the transaction

Parameters:

consumer - The consumer to call for each entity

getAllAffectedEntities

public List<Entity> getAllAffectedEntities()

Get all entities that have been affected in any way (created, updated or deleted) during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

all entities that have been affected in any way (created, updated or deleted) during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withAllAffectedEntities

public void withAllAffectedEntities(Consumer<Entity> consumer,
 Predicate<Entity> predicate)

Do something with the entities that have been affected in any way (created, updated or deleted) during the transaction

Parameters:

consumer - The consumer to call for each entity

predicate - The predicate to filter the updated entities by

getAllAffectedEntities

public List<Entity> getAllAffectedEntities(Predicate<Entity> predicate)

Get all entities that have been affected in any way (created, updated or deleted) during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

all entities that have been affected in any way (created, updated or deleted) during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withAffectedEntities

public void withAffectedEntities(Consumer<Entity> consumer)

Do something with the entities that have been created or updated during the transaction

Parameters:

consumer - The consumer to call for each entity

getAffectedEntities

public List<Entity> getAffectedEntities()

Get all entities that have been created or updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been created or updated during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withAffectedEntities

public void withAffectedEntities(Consumer<Entity> consumer,
 Predicate<Entity> predicate)

Do something with the entities that have been created or updated during the transaction

Parameters:

consumer - The consumer to call for each entity

predicate - The predicate to filter the updated entities by

getAffectedEntities

public List<Entity> getAffectedEntities(Predicate<Entity> predicate)

Get all entities that have been created or updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been created or updated during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withCreatedEntities

public void withCreatedEntities(Consumer<Entity> consumer)

Do something with the entities that have been created during the transaction

Parameters:

consumer - The consumer to call for each entity

getCreatedEntities

public List<Entity> getCreatedEntities()

Get all entities that have been created during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been created during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withCreatedEntities

public void withCreatedEntities(Consumer<Entity> consumer,
 Predicate<Entity> predicate)

Do something with the entities that have been created during the transaction

Parameters:

consumer - The consumer to call for each entity

predicate - The predicate to filter the updated entities by

getCreatedEntities

public List<Entity> getCreatedEntities(Predicate<Entity> predicate)

Get all entities that have been created during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been created during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withUpdatedEntities

public void withUpdatedEntities(Consumer<Entity> consumer)

Do something with the entities that have been updated during the transaction

Parameters:

consumer - The consumer to call for each entity

getUpdatedEntities

public List<Entity> getUpdatedEntities()

Get all entities that have been updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been updated during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withUpdatedEntities

public void withUpdatedEntities(Consumer<Entity> consumer,
 Predicate<Entity> predicate)

Do something with the entities that have been updated during the transaction

Parameters:

consumer - The consumer to call for each entity

predicate - The predicate to filter the updated entities by

getUpdatedEntities

public List<Entity> getUpdatedEntities(Predicate<Entity> predicate)

Get the updated entities. Caution: If possible, invalid input: 'should be used as with {@link #withUpdatedEntities(Consumer, Predicate) the consumer is executed directly for the relevant entities whereas here a new list has to be created first containing the relevant entities, which costs time and memory. @return entities that have been updated during the transaction @see #getAllAffectedEntities() @see #getAffectedEntities() @see #getCreatedEntities() @see #getUpdatedEntities() @see #getDeletedEntities()'

withDeletedEntities

public void withDeletedEntities(Consumer<Entity> consumer)

Do something with the entities that have been updated during the transaction

Parameters:

consumer - The consumer to call for each entity

getDeletedEntities

public List<Entity> getDeletedEntities()

Get all entities that have been created or updated during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been deleted or updated during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

withDeletedEntities

public void withDeletedEntities(Consumer<Entity> consumer,
 Predicate<Entity> predicate)

Do something with the entities that have been deleted during the transaction

Parameters:

consumer - The consumer to call for each entity

predicate - The predicate to filter the updated entities by

getDeletedEntities

public List<Entity> getDeletedEntities(Predicate<Entity> predicate)

Get all entities that have been deleted during the transaction Caution: for performance and memory consumption reasons, the corresponding `with...(Consumer, ...)` should be used whenever possible.

Returns:

entities that have been deleted during the transaction

See Also:

• getAllAffectedEntities()
• getAffectedEntities()
• getCreatedEntities()
• getUpdatedEntities()
• getDeletedEntities()

getOldValues

public Map<String,Object> getOldValues(Entity e)

getRelationChanges

public List<EntityRelationChangedEvent> getRelationChanges(Entity e)

getAddedRelationChanges

public List<EntityRelationChangedEvent> getAddedRelationChanges(Entity e)

getRemovedRelationChanges

public List<EntityRelationChangedEvent> getRemovedRelationChanges(Entity e)

getRelationChangesFor

public List<EntityRelationChangedEvent> getRelationChangesFor(Entity e,
 String... relationNames)

getRelationChangesFor

public List<EntityRelationChangedEvent> getRelationChangesFor(Entity e,
 Collection<String> relationNames)

getAddedRelationChangesFor

public List<EntityRelationChangedEvent> getAddedRelationChangesFor(Entity e,
 String relationName)

getRemovedRelationChangesFor

public List<EntityRelationChangedEvent> getRemovedRelationChangesFor(Entity e,
 String relationName)

getAllRelationChanges

public List<EntityRelationChangedEvent> getAllRelationChanges()

entityCreating

public final void entityCreating(EntityFacadeEvent event)

Description copied from interface: EntityFacadeListener

Fired when an entity is being created.

Specified by:

entityCreating in interface EntityFacadeListener

Parameters:

event - The event object.

onEntityCreating

protected void onEntityCreating(EntityFacadeEvent event)

entityDeleting

public final void entityDeleting(EntityFacadeEvent event)

Description copied from interface: EntityFacadeListener

Fired when an entity is being deleted.

Specified by:

entityDeleting in interface EntityFacadeListener

Parameters:

event - The event Object

onEntityDeleting

protected void onEntityDeleting(EntityFacadeEvent event)

isValidTx

protected boolean isValidTx(EntityFacadeEvent event)

entityChanging

public final void entityChanging(EntityChangedEvent event)

Description copied from interface: EntityFacadeListener

Fired when any changes are made to an entity.

Specified by:

entityChanging in interface EntityFacadeListener

Parameters:

event - The event object.

onEntityChanging

protected void onEntityChanging(EntityChangedEvent event)

entityRelationChanging

public final void entityRelationChanging(EntityRelationChangedEvent event)

Description copied from interface: EntityFacadeListener

Fired when a relation of an entity has been changed.

Specified by:

entityRelationChanging in interface EntityFacadeListener

Parameters:

event - The event object.

onEntityRelationChanging

protected void onEntityRelationChanging(EntityRelationChangedEvent event)

contextDestroying

public final void contextDestroying(ContextEvent event)

Specified by:

contextDestroying in interface ContextListener

transactionStarted

public void transactionStarted(TransactionStartedEvent event)

Specified by:

transactionStarted in interface ContextListener

entityModel

public static CollectingEntityListener.EntityModelNamePredicate entityModel(String entityModelName)

Create a CollectingEntityListener.EntityModelNamePredicate.

fieldTouched

public static CollectingEntityListener.FieldTouchedPredicate fieldTouched(String... fieldNames)

Create a CollectingEntityListener.FieldTouchedPredicate.

fieldTouched

public static CollectingEntityListener.FieldTouchedPredicate fieldTouched(Collection<String> fieldNames)

Create a CollectingEntityListener.FieldTouchedPredicate.

relationTouched

public static CollectingEntityListener.RelationTouchedPredicate relationTouched(String... relationNames)

Create a CollectingEntityListener.RelationTouchedPredicate.

relationTouched

public static CollectingEntityListener.RelationTouchedPredicate relationTouched(Collection<String> relationNames)

Create a CollectingEntityListener.RelationTouchedPredicate.