com.stripe.model.EventDataObjectDeserializer Maven / Gradle / Ivy
// Generated by delombok at Tue Sep 03 10:42:51 PDT 2019
package com.stripe.model;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.stripe.Stripe;
import com.stripe.exception.EventDataObjectDeserializationException;
import java.util.Map;
import java.util.Optional;
/**
* Deserialization helper to get {@code StripeObject} and handle failure due to schema
* incompatibility between the data object and the model classes. Event data object by default
* corresponds to the schema at API version tied to your Stripe account at the event creation time.
* This event version is in {@link Event#getApiVersion()}. The model classes for deserialization,
* however, corresponds to a specific version pinned to this library {@link Stripe#API_VERSION}.
* Thus, only data object with same API versions is guaranteed to deserialize safely.
*
* To avoid this problem of API version mismatch, create a new webhook endpoint `api_versions`
* corresponding to {@link Stripe#API_VERSION}. For more information, see API reference
*
*
In practice, each API version update only affects specific set of classes, so event data
* object for the unaffected classes can still be serialized successfully -- even when the API
* versions do not match. (Although it is considered unsafe by the API version comparison.) In that
* case, you can use {@link EventDataObjectDeserializer#deserializeUnsafe()}
*
*
Old events from {@link Event#retrieve(String)} or {@link Event#list(Map)} will have immutable
* API versions on them, and there is currently no support for rendering it at different API
* versions. If you find failure from reading these events, consider defining your own custom {@link
* CompatibilityTransformer} to transform the raw JSON to one with schema compatible with this
* current model classes.
*
*
En event integration from webhook may look like the example below. Assuming that you have the
* event api version matching this library, you should safely find deserialized object from the
* deserializer.
*
*
* Event event = Webhook.constructEvent(payload, sigHeader, secret);
* EventDataObjectDeserializer dataObjectDeserializer = event.getDataObjectDeserializer();
* if (dataObjectDeserializer.getObject().isPresent()) {
* StripeObject stripeObject = dataObjectDeserializer.getObject().get();
* doSomething(stripeObject);
* } else {
* throw new IllegalStateException(
* String.format("Unable to deserialize event data object for %s", event));
* }
*
*/
public class EventDataObjectDeserializer {
/**
* API version of the event data object.
*/
String apiVersion;
/**
* Event type to which this event data object belongs to.
*/
String eventType;
/**
* Raw JSON response to be deserialized into {@code StripeObject}.
*/
JsonObject rawJsonObject;
/**
* Deserialized {@code StripeObject} set during successful/safe deserialization.
*/
private StripeObject object;
EventDataObjectDeserializer(String apiVersion, String eventType, JsonObject rawJsonObject) {
this.apiVersion = apiVersion;
this.rawJsonObject = rawJsonObject;
this.eventType = eventType;
}
/**
* Gets an {@code Optional} of data event object, in favor of the deprecated {@link
* EventData#getObject()}. When the optional is present, the deserialized {@code StripeObject}
* preserves high data integrity because of correspondence between schema of the API response and
* the model class (the underlying concrete class for abstract {@code StripeObject}) schema. This
* is when {@link Event#getApiVersion()} matches {@link Stripe#API_VERSION}. Otherwise, the
* optional is empty.
*
* @return {@code Optional} of stripe object when deserialization is safe.
*/
public Optional getObject() {
if (object != null) {
return Optional.of(object);
}
if (deserialize()) {
return Optional.of(object);
} else {
return Optional.empty();
}
}
/**
* Get raw JSON string for the data object. This is the same data available in {@link
* EventDataObjectDeserializationException#getRawJson()} upon deserialization failure.
*
* @return JSON string the event data object.
*/
public String getRawJson() {
return rawJsonObject.toString();
}
/**
* Safe deserialize raw JSON into {@code StripeObject}. This operation mutates the state, and the
* successful result can be accessed via {@link EventDataObjectDeserializer#getObject()}. Matching
* {@link Event#getApiVersion()} and {@link Stripe#API_VERSION} is necessary condition to
* guarantee safe deserialization.
*
* @return whether deserialization has been successful.
*/
private boolean deserialize() {
if (!apiVersionMatch()) {
// when version mismatch, even when deserialization is successful,
// we cannot guarantee data correctness. Old events containing fields that should be
// translated/mapped to the new schema will simply not be captured by the new schema.
return false;
} else if (object != null) {
// already successfully deserialized
return true;
} else {
try {
object = EventDataDeserializer.deserializeStripeObject(rawJsonObject);
return true;
} catch (JsonParseException e) {
// intentionally ignore exception to fulfill simply whether deserialization succeeds
return false;
}
}
}
/**
* Force deserialize raw JSON to {@code StripeObject}. The deserialized data is not guaranteed to
* fully represent the JSON. For example, events of new API version having fields that are not
* captured by current model class will be lost. Similarly, events of old API version having
* fields that should be translated into the new fields, like field rename, will be lost.
*
* Upon deserialization failure, consider making the JSON compatible to the current model
* classes and recover from failure with {@link
* EventDataObjectDeserializer#deserializeUnsafeWith(CompatibilityTransformer)}.
*
* @return Object with no guarantee on full representation of its original raw JSON response.
* @throws EventDataObjectDeserializationException exception that contains the message error and
* the raw JSON response of the {@code StripeObject} to be deserialized.
*/
public StripeObject deserializeUnsafe() throws EventDataObjectDeserializationException {
try {
return EventDataDeserializer.deserializeStripeObject(rawJsonObject);
} catch (JsonParseException e) {
String errorMessage;
if (!apiVersionMatch()) {
errorMessage = String.format("Current `stripe-java` integration has Stripe API version %s, but the event data object has %s. The JSON data might have schema not compatible with the current model classes; such incompatibility can be the cause of deserialization failure. If you are deserializing webhoook events, consider creating a different webhook endpoint with `api_version` at %s. See Stripe API reference for more details. If you are deserializing old events from `Event#retrieve`, consider transforming the raw JSON data object to be compatible with this current model class schemas using `deserializeUnsafeWith`. Original error message: %s", getIntegrationApiVersion(), this.apiVersion, getIntegrationApiVersion(), e.getMessage());
} else {
errorMessage = String.format("Unable to deserialize event data object to respective Stripe object. Please see the raw JSON, and contact [email protected] for assistance. Original error message: %s", e.getMessage());
}
throw new EventDataObjectDeserializationException(errorMessage, rawJsonObject.toString());
}
}
/**
* Deserialize JSON that has been processed by {@link
* CompatibilityTransformer#transform(JsonObject, String, String)} into {@code StripeObject}. This
* deserialization method should only be used to handle events with schema incompatible to model
* class schema of this library. Throws {@link JsonParseException} when the transformed JSON
* remains incompatible with the model classes.
*
* @return deserialized {@code StripeObject} from user-supplied compatible JSON.
*/
public StripeObject deserializeUnsafeWith(CompatibilityTransformer transformer) {
return EventDataDeserializer.deserializeStripeObject(transformer.transform(rawJsonObject.deepCopy(), apiVersion, eventType));
}
private boolean apiVersionMatch() {
return getIntegrationApiVersion().equals(this.apiVersion);
}
/**
* Internal method to allow for testing with different Stripe version.
*/
String getIntegrationApiVersion() {
return Stripe.API_VERSION;
}
/**
* Definition of event data object JSON transformation to be compatible to API version of the
* library.
*/
public interface CompatibilityTransformer {
/**
* Transform event data object JSON into a schema compatible with model classes of the library.
* When used in {@link
* EventDataObjectDeserializer#deserializeUnsafeWith(CompatibilityTransformer)}. the resulting
* JSON will be deserialized to {@code StripeObject}.
*
* @param rawJsonObject event data object JSON to be transformed. Direct mutation is allowed.
* @param apiVersion API version of the event data object
* @param eventType event type to which this event data object belongs to.
* @return transformed JSON with schema compatible to the model class in this library.
*/
JsonObject transform(JsonObject rawJsonObject, String apiVersion, String eventType);
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof EventDataObjectDeserializer)) return false;
final EventDataObjectDeserializer other = (EventDataObjectDeserializer) o;
if (!other.canEqual((java.lang.Object) this)) return false;
final java.lang.Object this$apiVersion = this.apiVersion;
final java.lang.Object other$apiVersion = other.apiVersion;
if (this$apiVersion == null ? other$apiVersion != null : !this$apiVersion.equals(other$apiVersion)) return false;
final java.lang.Object this$eventType = this.eventType;
final java.lang.Object other$eventType = other.eventType;
if (this$eventType == null ? other$eventType != null : !this$eventType.equals(other$eventType)) return false;
final java.lang.Object this$rawJsonObject = this.rawJsonObject;
final java.lang.Object other$rawJsonObject = other.rawJsonObject;
if (this$rawJsonObject == null ? other$rawJsonObject != null : !this$rawJsonObject.equals(other$rawJsonObject)) return false;
final java.lang.Object this$object = this.getObject();
final java.lang.Object other$object = other.getObject();
if (this$object == null ? other$object != null : !this$object.equals(other$object)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof EventDataObjectDeserializer;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = 1;
final java.lang.Object $apiVersion = this.apiVersion;
result = result * PRIME + ($apiVersion == null ? 43 : $apiVersion.hashCode());
final java.lang.Object $eventType = this.eventType;
result = result * PRIME + ($eventType == null ? 43 : $eventType.hashCode());
final java.lang.Object $rawJsonObject = this.rawJsonObject;
result = result * PRIME + ($rawJsonObject == null ? 43 : $rawJsonObject.hashCode());
final java.lang.Object $object = this.getObject();
result = result * PRIME + ($object == null ? 43 : $object.hashCode());
return result;
}
}