Merge pull request #152 from SpineEventEngine/annotate-protobuf

Annotate Protobuf via SPI and internal

Author: alexander-yevsyukov

build.gradle

@@ -15,7 +15,7 @@ allprojects {
     apply plugin: 'jacoco'
 
     group = 'org.spine3'
-    version = '0.4.2-SNAPSHOT'
+    version = '0.4.2'
 }
 
 project.ext {

client/src/main/proto/spine/annotations.proto

@@ -105,3 +105,8 @@ extend google.protobuf.FileOptions {
     // See more info in `annotations.proto`.
     bool beta_all = 58011;
 }
+
+extend google.protobuf.ServiceOptions {
+    // Indicates that the service is a part of Service Provider Interface (SPI).
+    bool SPI_service = 58012;
+}

client/src/main/proto/spine/validate.proto

@@ -19,7 +19,7 @@
 //
 syntax = "proto3";
 
-// We do not define the package for this file to allow shorter options for user-defined types.
+// We do not define a package for this file to allow shorter options for user-defined types.
 // This would allow to write:
 //
 //     [(required).value = true];
@@ -34,8 +34,12 @@ option java_multiple_files = true;
 option java_outer_classname = "ValidationProto";
 option java_package = "org.spine3.validate.internal";
 
+option (internal_all) = true;
+
 import "google/protobuf/descriptor.proto";
 
+import "spine/annotations.proto";
+
 // TODO:2016-02-18:alexander.litus: obtain globally unique field number(s) for opts from Google.
 
 // A type of an entity.

server/src/main/java/org/spine3/server/event/grpc/package-info.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2016, TeamDev Ltd. All rights reserved.
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * Classes and interfaces generated from gRPC service definitions into this package are
+ * a part of Service Provider Interface (SPI) of the framework. As such they are not
+ * supposed to be used by code of applications.
+ */
+
+@SPI
+@ParametersAreNonnullByDefault
+package org.spine3.server.event.grpc;
+
+import org.spine3.SPI;
+
+import javax.annotation.ParametersAreNonnullByDefault;

server/src/main/proto/spine/server/aggregate/snapshot.proto

@@ -28,9 +28,12 @@ option java_package = "org.spine3.server.aggregate";
 
 import public "google/protobuf/any.proto";
 import public "google/protobuf/timestamp.proto";
+import "spine/annotations.proto";
 
 // Built-in event type for storing aggregate snapshots.
 message Snapshot {
+    option (SPI_type) = true;
+
     // The state of the aggregate.
     google.protobuf.Any state = 1;
 

server/src/main/proto/spine/server/event/event_store.proto

@@ -24,16 +24,20 @@ package spine.server.event;
 option java_generate_equals_and_hash = true;
 option java_multiple_files = true;
 option java_outer_classname = "EventStoreProto";
-// Put under the 'grpc' sub-package, which is @Internal.
+
+// Put generated code under the 'grpc' sub-package, which is annotated @SPI.
 option java_package = "org.spine3.server.event.grpc";
 
-import public "spine/base/event.proto";
-import public "spine/base/response.proto";
+import "spine/annotations.proto";
+import "spine/base/event.proto";
+import "spine/base/response.proto";
 
-import public "spine/server/event/event_stream_query.proto";
+import "spine/server/event/event_stream_query.proto";
 
 // `EventStore` service allows to store events and read them via streams.
 service EventStore {
+    option (SPI_service) = true;
+
     // Request to append events to the storage.
     rpc Append(base.Event) returns (base.Response);
 

server/src/main/proto/spine/server/storage/aggregate_storage.proto

@@ -26,8 +26,11 @@ option java_outer_classname = "AggregateStorageProto";
 option java_multiple_files = true;
 option java_generate_equals_and_hash = true;
 
+option (SPI_all) = true;
+
 import public "spine/server/aggregate/snapshot.proto";
 import public "spine/base/event.proto";
+import "spine/annotations.proto";
 
 // A record in the storage of events and snapshots of an aggregate type.
 //

server/src/main/proto/spine/server/storage/command_storage.proto

@@ -26,12 +26,15 @@ option java_multiple_files = true;
 option java_outer_classname = "CommandStoreProto";
 option java_generate_equals_and_hash = true;
 
+option (SPI_all) = true;
+
 import "google/protobuf/timestamp.proto";
 import "google/protobuf/any.proto";
 
 import "spine/base/command.proto";
 import "spine/base/error.proto";
 import "spine/base/failure.proto";
+import "spine/annotations.proto";
 
 // This type defines the way commands are stored in command storage.
 // Some of the fields are defined as string representation of corresponding message types

server/src/main/proto/spine/server/storage/entity_storage.proto

@@ -26,8 +26,12 @@ option java_multiple_files = true;
 option java_outer_classname = "EntityStorageProto";
 option java_package = "org.spine3.server.storage";
 
-import public "google/protobuf/timestamp.proto";
-import public "google/protobuf/any.proto";
+option (SPI_all) = true;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/any.proto";
+
+import "spine/annotations.proto";
 
 // Used to store entities in the entity storage.
 message EntityStorageRecord {

server/src/main/proto/spine/server/storage/event_storage.proto

@@ -26,10 +26,13 @@ option java_multiple_files = true;
 option java_outer_classname = "EventStorageProto";
 option java_generate_equals_and_hash = true;
 
+option (SPI_all) = true;
+
 import "google/protobuf/any.proto";
 import "google/protobuf/timestamp.proto";
 
 import "spine/base/event.proto";
+import "spine/annotations.proto";
 
 // This type defines the way events are stored in event storage.
 // Some of the fields are defined as string representation of corresponding message types