Package org.apache.juneau.petstore.service

Class PendingChanges

java.lang.Object

org.apache.juneau.petstore.service.PendingChanges

public class PendingChanges
extends Object

The staging area for pet-detail inline edits: edits are staged here instead of mutating the pet, then applied (perRow, with retry on failure) or discarded (aggregate) from the Pending changes page.

Obtained from PetStore.pendingChanges(). All methods are synchronized; the store is a demo, not a transactional system.

Example:

PendingChanges pc = store.pendingChanges(); PendingChange c = pc.stage(1, "price", "42.50", "alice"); pc.stage(1, "status", "SOLD", "alice"); pc.apply(c.getId(), "console:alice"); // pet 1 now costs 42.50 PendingChanges.DiscardOutcome out = pc.discard(List.of("7", "8"), "console:alice");

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PendingChanges.DiscardOutcome	Result of an aggregate discard, mapped 1:1 onto the console's BulkResult by ChangesRest.
static final record	PendingChanges.Failure	One failed id in a PendingChanges.DiscardOutcome.

Method Summary

Modifier and Type	Method	Description
PendingChange	apply(long id, String actor)	Writes a pending change to its pet.
PendingChanges.DiscardOutcome	discard(Collection<String> ids, String actor)	Discards pending changes in one aggregate call.
PendingChange	get(long id)	Returns one change.
List<PendingChange>	list()
List<PendingChange>	pending()
PendingChange	retry(long id, String actor)	Re-applies a failed change.
PendingChange	stage(long petId, String field, String newValue, String author)	Stages an edit without touching the pet.

Methods inherited from class java.lang.Object

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

Method Details

stage

public PendingChange stage(long petId,
 String field,
 String newValue,
 String author)

Stages an edit without touching the pet.

Parameters:

petId - The pet id.

field - One of "name", "price", "species", "status" or "tags" (tags is a comma-separated list; blank clears).

newValue - The new value (string form).

author - Who staged it.

Returns:

The new pending change.

Throws:

PetstoreNotFoundException - If the pet does not exist.

IllegalArgumentException - If the field is not stageable or the value is invalid.

list

public List<PendingChange> list()

Returns:

All changes, staging order. Immutable snapshot.

pending

public List<PendingChange> pending()

Returns:

Only PendingChange.State.PENDING changes, staging order. Immutable snapshot.

get

public PendingChange get(long id)

Returns one change.

Parameters:

id - The change id.

Returns:

The change.

Throws:

PetstoreNotFoundException - If it does not exist.

apply

public PendingChange apply(long id,
 String actor)

Writes a pending change to its pet. If the pet is gone, the change becomes FAILED instead.

Parameters:

id - The change id.

actor - The audit actor.

Returns:

The change, now APPLIED or FAILED.

Throws:

PetstoreNotFoundException - If the change does not exist.

PetstoreConflictException - If the change is not pending.

retry

public PendingChange retry(long id,
 String actor)

Re-applies a failed change.

Parameters:

id - The change id.

actor - The audit actor.

Returns:

The change, now APPLIED or still FAILED.

Throws:

PetstoreNotFoundException - If the change does not exist.

PetstoreConflictException - If the change has not failed.

discard

public PendingChanges.DiscardOutcome discard(Collection<String> ids,
 String actor)

Discards pending changes in one aggregate call.

Parameters:

ids - The change ids (string form, as sent by the bulk action).

actor - The audit actor.

Returns:

The per-id outcome.