[GitHub] rabbah commented on a change in pull request #2624: Add cache invalidation between controllers

[gi...@git.apache.org]

rabbah commented on a change in pull request #2624: Add cache invalidation between controllers
URL: https://github.com/apache/incubator-openwhisk/pull/2624#discussion_r133849127
 
 

 ##########
 File path: common/scala/src/main/scala/whisk/core/entity/CacheKey.scala
 ##########
 @@ -0,0 +1,37 @@
+/*
+ * 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.entity
+
+import spray.json.DefaultJsonProtocol
+
+/**
+ * A key that is used to store an entity on the cache.
+ *
+ * @param mainId The main part for the key to be used. For example this is the id of a document.
+ * @param secondaryId A second part of the key. For example the revision of an entity. This part
+ * of the key will not be written to the logs.
+ */
+case class CacheKey(mainId: String, secondaryId: Option[String] = None) {
+    override def toString() = {
+        s"CacheKey($mainId)"
 
 Review comment:
   please audit uses of toString so that we aren't logging keys that shouldn't be.
 
----------------------------------------------------------------
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