Add explicit class to access the "x_doc_resources" cache By having an own class representing this cache the construction of the cache key can be done in a single place and the callers don't have to worry about it. Change-Id: I8bd5b9d7a47294237bf6028d98c338e68153ed89 Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocCache.java b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocCache.java new file mode 100644 index 0000000..7c89d92 --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocCache.java
@@ -0,0 +1,44 @@ +// Copyright (C) 2014 The Android Open Source Project +// +// 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. + +package com.googlesource.gerrit.plugins.xdocs; + +import com.google.common.cache.LoadingCache; +import com.google.gerrit.httpd.resources.Resource; +import com.google.gerrit.reviewdb.client.Project; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import com.google.inject.name.Named; + +import com.googlesource.gerrit.plugins.xdocs.XDocLoader; +import com.googlesource.gerrit.plugins.xdocs.formatter.Formatters.FormatterProvider; + +import org.eclipse.jgit.lib.ObjectId; + +@Singleton +public class XDocCache { + private final LoadingCache<String, Resource> cache; + + @Inject + XDocCache( + @Named(XDocLoader.Module.X_DOC_RESOURCES) LoadingCache<String, Resource> cache) { + this.cache = cache; + } + + public Resource get(FormatterProvider formatter, Project.NameKey project, + String file, ObjectId revId) { + return cache.getUnchecked((new XDocResourceKey(formatter.getName(), + project, file, revId)).asString()); + } +}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocFileWebLink.java b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocFileWebLink.java index 934e9b1..c0c35a3 100644 --- a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocFileWebLink.java +++ b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocFileWebLink.java
@@ -14,14 +14,11 @@ package com.googlesource.gerrit.plugins.xdocs; -import com.google.common.cache.LoadingCache; import com.google.gerrit.extensions.annotations.PluginName; import com.google.gerrit.extensions.webui.FileWebLink; -import com.google.gerrit.httpd.resources.Resource; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.project.ProjectCache; import com.google.inject.Inject; -import com.google.inject.name.Named; import com.googlesource.gerrit.plugins.xdocs.formatter.Formatters; @@ -31,7 +28,7 @@ XDocFileWebLink( @PluginName String pluginName, GitRepositoryManager repoManager, - @Named(XDocLoader.Module.X_DOC_RESOURCES) LoadingCache<String, Resource> cache, + XDocCache cache, XDocProjectConfig.Factory cfgFactory, ProjectCache projectCache, Formatters formatters) {
diff --git a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocServlet.java b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocServlet.java index 0c61366..eea1cf6 100644 --- a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocServlet.java +++ b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocServlet.java
@@ -19,7 +19,6 @@ import com.google.common.base.CharMatcher; import com.google.common.base.MoreObjects; -import com.google.common.cache.LoadingCache; import com.google.common.hash.Hashing; import com.google.common.net.HttpHeaders; import com.google.gerrit.extensions.restapi.AuthException; @@ -41,7 +40,6 @@ import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.Singleton; -import com.google.inject.name.Named; import com.googlesource.gerrit.plugins.xdocs.formatter.Formatters; import com.googlesource.gerrit.plugins.xdocs.formatter.Formatters.FormatterProvider; @@ -78,7 +76,7 @@ private final ProjectCache projectCache; private final Provider<GetHead> getHead; private final GitRepositoryManager repoManager; - private final LoadingCache<String, Resource> docCache; + private final XDocCache docCache; private final FileTypeRegistry fileTypeRegistry; private final XDocProjectConfig.Factory cfgFactory; private final Formatters formatters; @@ -90,7 +88,7 @@ ProjectCache projectCache, Provider<GetHead> getHead, GitRepositoryManager repoManager, - @Named(XDocLoader.Module.X_DOC_RESOURCES) LoadingCache<String, Resource> cache, + XDocCache cache, FileTypeRegistry fileTypeRegistry, XDocProjectConfig.Factory cfgFactory, Formatters formatters) { @@ -191,8 +189,7 @@ Resource rsc; if (formatter != null) { - rsc = docCache.getUnchecked( - (new XDocResourceKey(formatter.getName(), key.project, key.file, revId)).asString()); + rsc = docCache.get(formatter, key.project, key.file, revId); } else if ("image".equals(mimeType.getMediaType())) { rsc = getImageResource(repo, revId, key.file); } else {
diff --git a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocWebLink.java b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocWebLink.java index b11afe8..07460d8 100644 --- a/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocWebLink.java +++ b/src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocWebLink.java
@@ -14,7 +14,6 @@ package com.googlesource.gerrit.plugins.xdocs; -import com.google.common.cache.LoadingCache; import com.google.gerrit.extensions.annotations.PluginName; import com.google.gerrit.extensions.restapi.Url; import com.google.gerrit.extensions.webui.BranchWebLink; @@ -26,7 +25,6 @@ import com.google.gerrit.server.project.ProjectState; import com.google.inject.Inject; import com.google.inject.Singleton; -import com.google.inject.name.Named; import com.googlesource.gerrit.plugins.xdocs.formatter.Formatters; import com.googlesource.gerrit.plugins.xdocs.formatter.Formatters.FormatterProvider; @@ -46,7 +44,7 @@ private final String pluginName; private final GitRepositoryManager repoManager; - private final LoadingCache<String, Resource> docCache; + private final XDocCache docCache; private final XDocProjectConfig.Factory cfgFactory; private final ProjectCache projectCache; private final Formatters formatters; @@ -55,7 +53,7 @@ XDocWebLink( @PluginName String pluginName, GitRepositoryManager repoManager, - @Named(XDocLoader.Module.X_DOC_RESOURCES) LoadingCache<String, Resource> cache, + XDocCache cache, XDocProjectConfig.Factory cfgFactory, ProjectCache projectCache, Formatters formatters) { @@ -103,8 +101,7 @@ if (revId == null) { return null; } - Resource rsc = docCache.getUnchecked( - (new XDocResourceKey(formatter.getName(), p, fileName, revId)).asString()); + Resource rsc = docCache.get(formatter, p, fileName, revId); if (rsc != Resource.NOT_FOUND) { StringBuilder url = new StringBuilder(); url.append("plugins/");