Add a custom JSON deserializer for ChangeEvents

This deserializer is useful for plugins to be able to re-inject events
they may have gotten from elsewhere.

Change-Id: I11f6a7f2234f914a33ab83f3a44adce71dfc7e59
This commit is contained in:
Martin Fick
2014-12-11 17:03:15 -07:00
committed by David Pursehouse
parent 0aef6f1c91
commit f70c20a8f9
2 changed files with 52 additions and 0 deletions

View File

@@ -418,6 +418,9 @@ its own custom event class derived from
Plugins which define new Events should register them via the
`com.google.gerrit.server.events.EventTypes.registerClass()`
method. This will make the EventType known to the system.
Deserialzing events with the
`com.google.gerrit.server.events.EventDeserializer` class requires
that the event be registered in EventTypes.
[[validation]]
== Validation Listeners

View File

@@ -0,0 +1,49 @@
// Copyright (C) 2014 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.server.events;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonParseException;
import java.lang.reflect.Type;
/**
* JSON deserializer for {@link Event}s.
* <p>
* Deserialized objects are of an appropriate subclass based on the value of the
* top-level "type" element.
*/
public class EventDeserializer implements JsonDeserializer<Event> {
@Override
public Event deserialize(JsonElement json, Type typeOfT,
JsonDeserializationContext context) throws JsonParseException {
if (!json.isJsonObject()) {
throw new JsonParseException("Not an object");
}
JsonElement typeJson = json.getAsJsonObject().get("type");
if (typeJson == null || !typeJson.isJsonPrimitive()
|| !typeJson.getAsJsonPrimitive().isString()) {
throw new JsonParseException("Type is not a string: " + typeJson);
}
String type = typeJson.getAsJsonPrimitive().getAsString();
Class<?> cls = EventTypes.getClass(type);
if (cls == null) {
throw new JsonParseException("Unknown event type: " + type);
}
return context.deserialize(json, cls);
}
}