[lucene-solr] branch branch_8x updated: SOLR-14065: Deprecate Velocity

[is...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ishan pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/branch_8x by this push:
     new 8d07ba5  SOLR-14065: Deprecate Velocity
8d07ba5 is described below

commit 8d07ba5c9c87573ca602ac2aaf539b2ca5be3f99
Author: Ishan Chattopadhyaya <is...@apache.org>
AuthorDate: Thu Dec 12 16:13:32 2019 +0530

    SOLR-14065: Deprecate Velocity
---
 solr/CHANGES.txt                                                     | 2 ++
 .../src/java/org/apache/solr/response/VelocityResponseWriter.java    | 1 +
 solr/solr-ref-guide/src/velocity-response-writer.adoc                | 5 +++++
 3 files changed, 8 insertions(+)

diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 13cbf2d..b0d0b0a 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -101,6 +101,8 @@ Upgrade Notes
 * SOLR-14071: Untrusted configsets (ones that are uploaded via unsecured configset API) cannot use <lib> directive.
   Consider enabling authentication/authorization so that the uploaded configsets are trusted.
 
+* SOLR-14065: VelocityResponseWriter has been deprecated and may be removed in a future version.
+
 New Features
 ---------------------
 * SOLR-13821: A Package store to store and load package artifacts (noble, Ishan Chattopadhyaya)
diff --git a/solr/contrib/velocity/src/java/org/apache/solr/response/VelocityResponseWriter.java b/solr/contrib/velocity/src/java/org/apache/solr/response/VelocityResponseWriter.java
index 8594d50..a598ba2 100644
--- a/solr/contrib/velocity/src/java/org/apache/solr/response/VelocityResponseWriter.java
+++ b/solr/contrib/velocity/src/java/org/apache/solr/response/VelocityResponseWriter.java
@@ -96,6 +96,7 @@ public class VelocityResponseWriter implements QueryResponseWriter, SolrCoreAwar
 
   @Override
   public void init(NamedList args) {
+    log.warn("VelocityResponseWriter is deprecated. This may be removed in future Solr releases. Please SOLR-14065.");
     fileResourceLoaderBaseDir = null;
     String templateBaseDir = (String) args.get(TEMPLATE_BASE_DIR);
 
diff --git a/solr/solr-ref-guide/src/velocity-response-writer.adoc b/solr/solr-ref-guide/src/velocity-response-writer.adoc
index ef95196..50b9ec5 100644
--- a/solr/solr-ref-guide/src/velocity-response-writer.adoc
+++ b/solr/solr-ref-guide/src/velocity-response-writer.adoc
@@ -18,6 +18,11 @@
 
 The VelocityResponseWriter is an optional plugin available in the `contrib/velocity` directory. It powers the /browse user interfaces when using some example configurations such as "techproducts" and "example/files".
 
+[IMPORTANT]
+====
+The VelocityResponseWriter has been deprecated and may be removed in a future version of Solr.
+====
+
 Its JAR and dependencies must be added (via `<lib>` or solr/home lib inclusion), and must be registered in `solrconfig.xml` like this:
 
 [source,xml]