[GitHub] chetanmeh commented on a change in pull request #3453: Introduce a AttachmentStore SPI

[GitBox <gi...@apache.org>]

chetanmeh commented on a change in pull request #3453: Introduce a AttachmentStore SPI
URL: https://github.com/apache/incubator-openwhisk/pull/3453#discussion_r175763836
 
 

 ##########
 File path: common/scala/src/main/scala/whisk/core/database/AttachmentStore.scala
 ##########
 @@ -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 whisk.core.database
+
+import akka.http.scaladsl.model.ContentType
+import akka.stream.scaladsl.{Sink, Source}
+import akka.util.ByteString
+import whisk.common.TransactionId
+import whisk.core.entity.DocInfo
+
+import scala.concurrent.{ExecutionContext, Future}
+
+trait AttachmentStore {
+
+  /** Execution context for futures */
+  protected[core] implicit val executionContext: ExecutionContext
+
+  /**
+   * Attaches a "file" of type `contentType` to an existing document. The revision for the document must be set.
+   */
+  protected[core] def attach(doc: DocInfo, name: String, contentType: ContentType, docStream: Source[ByteString, _])(
+    implicit transid: TransactionId): Future[DocInfo]
+
+  /**
+   * Retrieves a saved attachment, streaming it into the provided Sink.
+   */
+  protected[core] def readAttachment[T](doc: DocInfo, name: String, sink: Sink[ByteString, Future[T]])(
+    implicit transid: TransactionId): Future[(ContentType, T)]
+
+  /**
+   * Deletes all attachments linked to given document
+   */
+  protected[core] def deleteAttachments(doc: DocInfo)(implicit transid: TransactionId): Future[Boolean]
 
 Review comment:
   Can be done ... currently its named as per method introduced with apache/incubator-openwhisk#3366. `deleteAttachments` conveys the intention clearly while detach is bit cryptic i.e. it may be interpreted as  that attachment still exist just link with main document broken 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services