This is an automated email from the ASF dual-hosted git repository. tmaret pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-journal-messages.git
commit 36a0fe43c43d88177adfae86cb0d2229572df173 Author: tmaret <[email protected]> AuthorDate: Tue Apr 16 23:53:03 2019 +0200 SLING-8346 - Import Journal based Sling Content Distribution source code This project contains Protocol Buffers message definition for the `org.apache.sling.distribution.journal` module. Initial contributors * Timothee Maret @tmaret * Christian Schneider @cschneider * Marius Petria @mpetria --- LICENSE | 202 +++++++++++++++++++++ README.md | 4 + bnd.bnd | 1 + pom.xml | 108 +++++++++++ .../messages/PackageDistributedMessage.java | 32 ++++ .../sling/distribution/journal/messages/Types.java | 51 ++++++ src/main/protobuf/messages.proto | 84 +++++++++ .../distribution/journal/messages/SerTest.java | 87 +++++++++ 8 files changed, 569 insertions(+) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7ea626d --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +org.apache.sling.distribution.journal.messages +=============================================== + +Project containing the [Protocol Buffers](https://developers.google.com/protocol-buffers) message definition for the `distribution.journal` module. \ No newline at end of file diff --git a/bnd.bnd b/bnd.bnd new file mode 100644 index 0000000..eaccb47 --- /dev/null +++ b/bnd.bnd @@ -0,0 +1 @@ +Export-Package: org.apache.sling.distribution.journal.messages \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..1f1eef1 --- /dev/null +++ b/pom.xml @@ -0,0 +1,108 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <!-- ======================================================================= --> + <!-- P A R E N T P R O J E C T --> + <!-- ======================================================================= --> + <parent> + <groupId>org.apache.sling</groupId> + <artifactId>sling</artifactId> + <version>34</version> + <relativePath /> + </parent> + + <!-- ======================================================================= --> + <!-- P R O J E C T --> + <!-- ======================================================================= --> + <artifactId>org.apache.sling.distribution.journal.messages</artifactId> + <version>0.0.1-INCUBATOR-SNAPSHOT</version> + + <name>Apache Sling Journal based Content Distribution - Messages bundle</name> + <description>Implementation of the messages to support Apache Sling Content Distribution on top of an append-only persisted log</description> + + <properties> + <sling.java.version>8</sling.java.version> + </properties> + + <scm/> + + <!-- ======================================================================= --> + <!-- B U I L D --> + <!-- ======================================================================= --> + <build> + <plugins> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <version>3.5.0</version> + <extensions>true</extensions> + </plugin> + <plugin> + <groupId>com.github.os72</groupId> + <artifactId>protoc-jar-maven-plugin</artifactId> + <version>3.5.1.1</version> + <executions> + <execution> + <phase>generate-sources</phase> + <goals> + <goal>run</goal> + </goals> + <configuration> + <protocVersion>2.5.0</protocVersion> + <outputTargets> + <outputTarget> + <type>java</type> + <addSources>true</addSources> + <outputDirectory>target/generated-sources/protoc-jar</outputDirectory> + </outputTarget> + </outputTargets> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + + <!-- ======================================================================= --> + <!-- D E P E N D E N C I E S --> + <!-- ======================================================================= --> + <dependencies> + <dependency> + <groupId>com.google.protobuf</groupId> + <artifactId>protobuf-java</artifactId> + <version>3.7.0</version> + </dependency> + + <!-- Test --> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.servicemix.bundles</groupId> + <artifactId>org.apache.servicemix.bundles.hamcrest</artifactId> + <version>1.3_1</version> + <scope>test</scope> + </dependency> + </dependencies> +</project> diff --git a/src/main/java/org/apache/sling/distribution/journal/messages/PackageDistributedMessage.java b/src/main/java/org/apache/sling/distribution/journal/messages/PackageDistributedMessage.java new file mode 100644 index 0000000..b26dea6 --- /dev/null +++ b/src/main/java/org/apache/sling/distribution/journal/messages/PackageDistributedMessage.java @@ -0,0 +1,32 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.sling.distribution.journal.messages; + +public class PackageDistributedMessage { + + public String pubAgentName; + + public String packageId; + + public String[] deepPaths; + + public String[] paths; + + public long offset; +} diff --git a/src/main/java/org/apache/sling/distribution/journal/messages/Types.java b/src/main/java/org/apache/sling/distribution/journal/messages/Types.java new file mode 100644 index 0000000..f49a103 --- /dev/null +++ b/src/main/java/org/apache/sling/distribution/journal/messages/Types.java @@ -0,0 +1,51 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.sling.distribution.journal.messages; + +import java.util.HashMap; +import java.util.Map; + +public class Types { + private static Map<Class<?>, Integer> types = new HashMap<>(); + static { + types.put(Messages.DiscoveryMessage.class, 1); + types.put(Messages.PackageMessage.class, 2); + types.put(Messages.PackageStatusMessage.class, 3); + types.put(Messages.CommandMessage.class, 4); + types.put(Messages.PingMessage.class, 5); + } + + public static Class<?> getType(int type, int version) { + for (Class<?> clazz : types.keySet()) { + Integer cType = types.get(clazz); + if (cType == type && version == 1) { + return clazz; + } + } + throw new IllegalArgumentException(String.format("Unknown type %d and version %d", type, version)); + } + + public static Integer getType(Class<?> clazz) { + return types.get(clazz); + } + + public static Integer getVersion(Class<?> clazz) { + return 1; + } +} diff --git a/src/main/protobuf/messages.proto b/src/main/protobuf/messages.proto new file mode 100644 index 0000000..e8dba7d --- /dev/null +++ b/src/main/protobuf/messages.proto @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.sling.distribution.journal.messages; + +message PackageMessage { + enum ReqType { + ADD = 0; + DELETE = 1; + TEST = 2; + } + required string pubSlingId = 1; // Publisher agent Sling identifier + //required int32 maxRetries = 9; + required ReqType reqType = 4; // The request type + required string pkgId = 3; // Content package identifier + required string pkgType = 11; // The package type + optional int64 pkgLength = 5; + optional bytes pkgBinary = 6; // The content package binary. Either the pkgBinary or the pkgBinaryRef field MUST be set. + optional string pkgBinaryRef = 10; // The reference to the content binary in the shared blob store. Either the pkgBinary or the pkgBinaryRef field MUST be set. + optional string pubAgentName = 2; // Publisher agent name + optional string userId = 12; + repeated string paths = 7; + repeated string deepPaths = 8; +} + +message PackageStatusMessage { + enum Status { + REMOVED_FAILED = 0; // The package has been removed automatically after failing every retry attempts + REMOVED = 1; // The package has been removed explicitly + IMPORTED = 2; // The package has been imported + } + required string subSlingId = 1; // Subscriber agent Sling identifier + required string subAgentName = 2; // Subscriber agent name + required string pubAgentName = 3; // Publisher agent name + required int64 offset = 4; // The offset of the package for which the status is given + required Status status = 5; // The package status +} + + +message SubscriberState { + required string pubAgentName = 1; // Publisher agent name + required int64 offset = 2; // Last processed offset on the Subscriber agent + optional int32 retries = 3; // Nb of retries for the current offset on the Subscriber agent +} + +message SubscriberConfiguration { + required bool editable = 1; + required int32 maxRetries = 2; // The max number of retry attempts to process this package. A value smaller than zero indicates an infinite number of retry attempts. A value greater or equal to zero indicates a specific number of retry attempts. +} + +message DiscoveryMessage { + required string subSlingId = 1; // Subscriber agent Sling identifier + required string subAgentName = 2; // Subscriber agent name + repeated SubscriberState subscriberState = 3; + required SubscriberConfiguration subscriberConfiguration = 4; +} + +message ClearCommand { + required int64 offset = 1; +} + +message CommandMessage { + required string subSlingId = 1; // Subscriber agent Sling identifier + required string subAgentName = 2; // Subscriber agent name + optional ClearCommand clearCommand = 3; +} + +message PingMessage { +} diff --git a/src/test/java/org/apache/sling/distribution/journal/messages/SerTest.java b/src/test/java/org/apache/sling/distribution/journal/messages/SerTest.java new file mode 100644 index 0000000..b093c34 --- /dev/null +++ b/src/test/java/org/apache/sling/distribution/journal/messages/SerTest.java @@ -0,0 +1,87 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.sling.distribution.journal.messages; + +import static org.apache.sling.distribution.journal.messages.Messages.SubscriberConfiguration; +import static org.hamcrest.Matchers.equalTo; +import static org.junit.Assert.assertThat; + +import java.lang.reflect.Method; + +import org.junit.Test; + +import org.apache.sling.distribution.journal.messages.Messages.DiscoveryMessage; +import org.apache.sling.distribution.journal.messages.Messages.DiscoveryMessageOrBuilder; +import org.apache.sling.distribution.journal.messages.Messages.SubscriberState; +import org.apache.sling.distribution.journal.messages.Messages.SubscriberStateOrBuilder; +import com.google.protobuf.ByteString; +import com.google.protobuf.ExtensionRegistryLite; +import com.google.protobuf.GeneratedMessage; +import com.google.protobuf.InvalidProtocolBufferException; + +public class SerTest { + + @Test + public void test() throws InvalidProtocolBufferException { + DiscoveryMessage discoveryMsg = createMessage(); + byte[] messageBytes = discoveryMsg.toByteArray(); + + ExtensionRegistryLite registry = ExtensionRegistryLite.newInstance(); + DiscoveryMessageOrBuilder messageIn = DiscoveryMessage.parseFrom(messageBytes, registry); + checkMessage(messageIn); + + } + + @Test + public void testFromClass() throws Exception { + DiscoveryMessage discoveryMsg = createMessage(); + ByteString byteString = discoveryMsg.toByteString(); + + ExtensionRegistryLite registry = ExtensionRegistryLite.newInstance(); + Class<? extends GeneratedMessage> type = DiscoveryMessage.class; + Method method = type.getMethod("parseFrom", ByteString.class, ExtensionRegistryLite.class); + DiscoveryMessage messageIn = (DiscoveryMessage) method.invoke(null, byteString, registry); + checkMessage(messageIn); + } + + private DiscoveryMessage createMessage() { + DiscoveryMessage discoveryMsg = DiscoveryMessage.newBuilder() + .setSubSlingId("subscribersling1") + .setSubAgentName("subscriber1") + .setSubscriberConfiguration(SubscriberConfiguration + .newBuilder() + .setEditable(false) + .setMaxRetries(-1) + .build()) + .addSubscriberState(SubscriberState + .newBuilder() + .setPubAgentName("publisher1") + .setOffset(10).build()) + .build(); + return discoveryMsg; + } + + private void checkMessage(DiscoveryMessageOrBuilder messageIn) { + assertThat(messageIn.getSubSlingId(), equalTo("subscribersling1")); + assertThat(messageIn.getSubAgentName(), equalTo("subscriber1")); + SubscriberStateOrBuilder offset = messageIn.getSubscriberStateList().iterator().next(); + assertThat(offset.getPubAgentName(), equalTo("publisher1")); + assertThat(offset.getOffset(), equalTo(10l)); + } +}
