diff options
Diffstat (limited to 'src/main/java/org/onap/aai/spike/event/outgoing')
6 files changed, 540 insertions, 0 deletions
diff --git a/src/main/java/org/onap/aai/spike/event/outgoing/GsonExclude.java b/src/main/java/org/onap/aai/spike/event/outgoing/GsonExclude.java new file mode 100644 index 0000000..2ba949a --- /dev/null +++ b/src/main/java/org/onap/aai/spike/event/outgoing/GsonExclude.java @@ -0,0 +1,32 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright © 2017-2018 Amdocs + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.spike.event.outgoing; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.FIELD}) +public @interface GsonExclude { + // Field tag only annotation +} diff --git a/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEdge.java b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEdge.java new file mode 100644 index 0000000..7fb030d --- /dev/null +++ b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEdge.java @@ -0,0 +1,143 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright © 2017-2018 Amdocs + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.spike.event.outgoing; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonElement; +import com.google.gson.annotations.SerializedName; +import org.onap.aai.spike.exception.SpikeException; + +/** + * This class provides a generic representation of an Edge as provided by the graph data store. + * + */ +public class SpikeEdge { + + /** + * The unique identifier used to identify this edge in the graph data store. + */ + @SerializedName("key") + private String id; + + @SerializedName("schema-version") + private String modelVersion; + + /** Type label assigned to this vertex. */ + private String type; + + /** Source vertex for our edge. */ + private SpikeVertex source; + + /** Target vertex for our edge. */ + private SpikeVertex target; + + /** Map of all of the properties assigned to this vertex. */ + private JsonElement properties; + + /** Marshaller/unmarshaller for converting to/from JSON. */ + private static final Gson gson = new GsonBuilder().disableHtmlEscaping().create(); + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public SpikeVertex getSource() { + return source; + } + + public void setSource(SpikeVertex source) { + this.source = source; + } + + public SpikeVertex getTarget() { + return target; + } + + public void setTarget(SpikeVertex target) { + this.target = target; + } + + public JsonElement getProperties() { + return properties; + } + + public void setProperties(JsonElement properties) { + this.properties = properties; + } + + public String getModelVersion() { + return modelVersion; + } + + public void setModelVersion(String modelVersion) { + this.modelVersion = modelVersion; + } + + /** + * Unmarshalls this Edge object into a JSON string. + * + * @return - A JSON format string representation of this Edge. + */ + public String toJson() { + return gson.toJson(this); + } + + /** + * Marshalls the provided JSON string into a Edge object. + * + * @param json - The JSON string to produce the Edge from. + * + * @return - A Edge object. + * + * @throws SpikeException + */ + public static SpikeEdge fromJson(String json) throws SpikeException { + + try { + + // Make sure that we were actually provided a non-empty string + // before we + // go any further. + if (json == null || json.isEmpty()) { + throw new SpikeException("Empty or null JSON string."); + } + + // Marshall the string into an Edge object. + return gson.fromJson(json, SpikeEdge.class); + + } catch (Exception ex) { + throw new SpikeException("Unable to parse JSON string: " + ex.getMessage()); + } + } +} diff --git a/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEventComparator.java b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEventComparator.java new file mode 100644 index 0000000..87ce2ce --- /dev/null +++ b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEventComparator.java @@ -0,0 +1,33 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright © 2017-2018 Amdocs + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.spike.event.outgoing; + +import java.util.Comparator; + +public class SpikeEventComparator implements Comparator<SpikeGraphEvent> { + + @Override + public int compare(SpikeGraphEvent e1, SpikeGraphEvent e2) { + + // Note: this will break down if the difference is more than 24 days, or int.max milliseconds + return (int) (e1.getOperationTimestamp() - e2.getOperationTimestamp()); + } +} diff --git a/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEventExclusionStrategy.java b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEventExclusionStrategy.java new file mode 100644 index 0000000..54ac391 --- /dev/null +++ b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeEventExclusionStrategy.java @@ -0,0 +1,37 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright © 2017-2018 Amdocs + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.spike.event.outgoing; + +import com.google.gson.ExclusionStrategy; +import com.google.gson.FieldAttributes; + +public class SpikeEventExclusionStrategy implements ExclusionStrategy { + + @Override + public boolean shouldSkipField(FieldAttributes fieldAttributes) { + return fieldAttributes.getAnnotation(GsonExclude.class) != null; + } + + @Override + public boolean shouldSkipClass(Class<?> aClass) { + return false; + } +} diff --git a/src/main/java/org/onap/aai/spike/event/outgoing/SpikeGraphEvent.java b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeGraphEvent.java new file mode 100644 index 0000000..a076a55 --- /dev/null +++ b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeGraphEvent.java @@ -0,0 +1,168 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright © 2017-2018 Amdocs + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.spike.event.outgoing; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.annotations.SerializedName; +import org.onap.aai.spike.exception.SpikeException; + +public class SpikeGraphEvent { + + public enum SpikeOperation { + CREATE, UPDATE, DELETE + } + + private SpikeOperation operation; + + @SerializedName("transaction-id") + private String transactionId; + + @SerializedName("database-transaction-id") + private String dbTransactionId; + + @SerializedName("timestamp") + private long operationTimestamp; + + private SpikeVertex vertex; + + private SpikeEdge relationship; + + // Time this event was received in spike, used to determine when to send the event + @GsonExclude + private long spikeTimestamp = System.currentTimeMillis(); + + /** Serializer/deserializer for converting to/from JSON. */ + private static final Gson gson = new GsonBuilder().disableHtmlEscaping().create(); + + public SpikeOperation getOperation() { + return operation; + } + + public void setOperation(SpikeOperation operation) { + this.operation = operation; + } + + public long getOperationTimestamp() { + return operationTimestamp; + } + + public void setOperationTimestamp(long operationTimestamp) { + this.operationTimestamp = operationTimestamp; + } + + + + public SpikeVertex getVertex() { + return vertex; + } + + public void setVertex(SpikeVertex vertex) { + this.vertex = vertex; + } + + public SpikeEdge getRelationship() { + return relationship; + } + + public void setRelationship(SpikeEdge relationship) { + this.relationship = relationship; + } + + public String getTransactionId() { + return transactionId; + } + + public void setTransactionId(String transactionId) { + this.transactionId = transactionId; + } + + public void setDbTransactionId(String dbTransactionId) { + this.dbTransactionId = dbTransactionId; + } + + public long getSpikeTimestamp() { + return spikeTimestamp; + } + + /** + * Unmarshalls this Vertex object into a JSON string. + * + * @return - A JSON format string representation of this Vertex. + */ + public String toJson() { + return gson.toJson(this); + } + + + /** + * Marshalls the provided JSON string into a Vertex object. + * + * @param json - The JSON string to produce the Vertex from. + * + * @return - A Vertex object. + * + * @throws SpikeException + */ + public static SpikeGraphEvent fromJson(String json) throws SpikeException { + + try { + // Make sure that we were actually provided a non-empty string + // before we + // go any further. + if (json == null || json.isEmpty()) { + throw new SpikeException("Empty or null JSON string."); + } + + // Marshall the string into a Vertex object. + return gson.fromJson(json, SpikeGraphEvent.class); + + } catch (Exception ex) { + throw new SpikeException("Unable to parse JSON string: " + ex.getMessage()); + } + } + + @Override + public String toString() { + return toJson(); + } + + public String getObjectKey() { + if (this.getVertex() != null) { + return this.getVertex().getId(); + } else if (this.getRelationship() != null) { + return this.getRelationship().getId(); + } + + return null; + } + + public String getObjectType() { + if (this.getVertex() != null) { + return "Vertex->" + this.getVertex().getType(); + } else if (this.getRelationship() != null) { + return "Relationship->" + this.getRelationship().getType(); + } + + return null; + } +} + diff --git a/src/main/java/org/onap/aai/spike/event/outgoing/SpikeVertex.java b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeVertex.java new file mode 100644 index 0000000..cd51855 --- /dev/null +++ b/src/main/java/org/onap/aai/spike/event/outgoing/SpikeVertex.java @@ -0,0 +1,127 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright © 2017-2018 Amdocs + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ +package org.onap.aai.spike.event.outgoing; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonElement; +import com.google.gson.annotations.SerializedName; +import org.onap.aai.spike.exception.SpikeException; + +/** + * This class provides a generic representation of a Vertex as provided by the graph data store. + * + */ +public class SpikeVertex { + + /** + * The unique identifier used to identify this vertex in the graph data store. + */ + @SerializedName("key") + private String id; + + @SerializedName("schema-version") + private String modelVersion; + + /** Type label assigned to this vertex. */ + private String type; + + /** Map of all of the properties assigned to this vertex. */ + private JsonElement properties; + + /** Marshaller/unmarshaller for converting to/from JSON. */ + private static final Gson gson = new GsonBuilder().disableHtmlEscaping().create(); + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public JsonElement getProperties() { + return properties; + } + + public void setProperties(JsonElement properties) { + this.properties = properties; + } + + public String getModelVersion() { + return modelVersion; + } + + public void setModelVersion(String modelVersion) { + this.modelVersion = modelVersion; + } + + /** + * Unmarshalls this Vertex object into a JSON string. + * + * @return - A JSON format string representation of this Vertex. + */ + public String toJson() { + return gson.toJson(this); + } + + /** + * Marshalls the provided JSON string into a Vertex object. + * + * @param json - The JSON string to produce the Vertex from. + * + * @return - A Vertex object. + * + * @throws SpikeException + */ + public static SpikeVertex fromJson(String json) throws SpikeException { + + try { + + // Make sure that we were actually provided a non-empty string + // before we + // go any further. + if (json == null || json.isEmpty()) { + throw new SpikeException("Empty or null JSON string."); + } + + // Marshall the string into a Vertex object. + return gson.fromJson(json, SpikeVertex.class); + + } catch (Exception ex) { + throw new SpikeException("Unable to parse JSON string: " + ex.getMessage()); + } + } + + @Override + public String toString() { + + return toJson(); + } +} |