Changeset 7079

Timestamp:

11/14/16 16:15:06 (8 years ago)

Author:

Oliver Schonefeld

Message:

• more complete legacy compat mode (to be used in FCS conformance tester)

Location:

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs

Files:

• AbstractClarinFCSRecordDataParser.java (modified) (2 diffs)
• ClarinFCSClientBuilder.java (modified) (4 diffs)
• ClarinFCSRecordData.java (modified) (1 diff)
• ClarinFCSRecordDataParser.java (modified) (1 diff)
• DataViewParserKWIC.java (modified) (4 diffs)
• LegacyClarinFCSRecordData.java (added)
• LegacyClarinFCSRecordDataParser.java (modified) (5 diffs)
• LegacyDataViewKWIC.java (added)

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs/AbstractClarinFCSRecordDataParser.java

@@ -94 +94 @@
 
 
-    protected SRURecordData parse(XMLStreamReader reader, String ns)
+    @SuppressWarnings("deprecation")
+    protected SRURecordData parse(XMLStreamReader reader, String ns,
+            boolean fullLegacyCompatMode)
             throws XMLStreamException, SRUClientException {
         // Resource
@@ -118 +120 @@
 
         XmlStreamReaderUtils.readEnd(reader, ns, "Resource", true);
-
-        return new ClarinFCSRecordData(pid, ref, dataviews, resourceFragments);
+        if (fullLegacyCompatMode) {
+            return new LegacyClarinFCSRecordData(pid, ref, dataviews,
+                    resourceFragments);
+        } else {
+            return new ClarinFCSRecordData(pid, ref, dataviews,
+                    resourceFragments);
+        }
     }
 

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs/ClarinFCSClientBuilder.java

@@ -42 +42 @@
             new ArrayList<SRUExtraResponseDataParser>();
     private SRUVersion defaultVersion = DEFAULT_SRU_VERSION;
-    private boolean unknownAsDom      = DEFAULT_UNKNOWN_AS_DOM;
-    private boolean legacySupport     = false;
-    private int connectTimeout        = SRUClientConfig.DEFAULT_CONNECT_TIMEOUT;
-    private int socketTimeout         = SRUClientConfig.DEFAULT_SOCKET_TIMEOUT;
+    private boolean unknownAsDom = DEFAULT_UNKNOWN_AS_DOM;
+    private boolean legacySupport = false;
+    private boolean fullLegacyCompatMode = false;
+    private int connectTimeout = SRUClientConfig.DEFAULT_CONNECT_TIMEOUT;
+    private int socketTimeout = SRUClientConfig.DEFAULT_SOCKET_TIMEOUT;
 
 
@@ -143 +144 @@
     public ClarinFCSClientBuilder disableLegacySupport() {
         legacySupport = false;
+        return this;
+    }
+
+
+    /**
+     * Configure client to support legacy CLARIN-FCS endpoints in full
+     * compatibility mode. Automatically enables support for legacy CLARIN-FCS.
+     * <br>
+     * NB: This feature should not be used in production!
+     *
+     * @return this {@link ClarinFCSClientBuilder} instance
+     */
+    public ClarinFCSClientBuilder enableFullLegacyCompatMode() {
+        enableLegacySupport();
+        fullLegacyCompatMode = true;
+        return this;
+    }
+
+
+    /**
+     * Configure client to disable support for legacy CLARIN_FCS in full
+     * compatibility mode. <br>
+     * NB: Support for legacy CLARIN-FCS will <em>not</em> be disabled
+     * automatically!
+     *
+     * @return this {@link ClarinFCSClientBuilder} instance
+     */
+    public ClarinFCSClientBuilder disableFullLegacyCompatMode() {
+        fullLegacyCompatMode = false;
         return this;
     }
@@ -300 +330 @@
         builder.addRecordDataParser(new ClarinFCSRecordDataParser(p));
         if (legacySupport) {
-            builder.addRecordDataParser(new LegacyClarinFCSRecordDataParser(p));
+            builder.addRecordDataParser(new LegacyClarinFCSRecordDataParser(p, fullLegacyCompatMode));
         }
         if ((extraDataParsers != null) && !extraDataParsers.isEmpty()) {
@@ -323 +353 @@
         }
         if (legacySupport) {
-            result.add(new DataViewParserKWIC());
+            result.add(new DataViewParserKWIC(fullLegacyCompatMode));
         }
         return result;

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs/ClarinFCSRecordData.java

@@ -32 +32 @@
     public static final String RECORD_SCHEMA =
             "http://clarin.eu/fcs/resource";
-    /**
-     * The legacy record schema for CLARIN-FCS records.
-     *
-     * @deprecated Only use to talk to legacy clients
-     */
-    @Deprecated
-    public static final String LEGACY_RECORD_SCHEMA =
-            "http://clarin.eu/fcs/1.0";
     private final Resource resource;
 

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs/ClarinFCSRecordDataParser.java

@@ -63 +63 @@
         logger.debug("parsing CLARIN-FCS record");
 
-        return parse(reader, ClarinFCSRecordData.RECORD_SCHEMA);
+        return parse(reader, ClarinFCSRecordData.RECORD_SCHEMA, false);
     }
 

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs/DataViewParserKWIC.java

@@ -40 +40 @@
     private static final String FCS_KWIC_NS = "http://clarin.eu/fcs/1.0/kwic";
     private static final String KWIC_LEGACY_TYPE = "kwic";
-    private static final String KWIC_TYPE =
-            "application/x-clarin-fcs-kwic+xml";
     private static final Logger logger =
             LoggerFactory.getLogger(DataViewParserKWIC.class);
+    private final boolean fullLegacyCompatMode;
+
+
+    public DataViewParserKWIC(boolean fullLegacyCompatMode) {
+        this.fullLegacyCompatMode = fullLegacyCompatMode;
+    }
+
 
     @Override
     public boolean acceptType(String type) {
-        return KWIC_TYPE.equals(type) || KWIC_LEGACY_TYPE.equals(type);
+        return LegacyDataViewKWIC.TYPE.equals(type) ||
+                KWIC_LEGACY_TYPE.equals(type);
     }
+
 
     @Override
@@ -54 +61 @@
         return 1000;
     }
+
 
     @Override
@@ -61 +69 @@
             logger.warn("type '" + KWIC_LEGACY_TYPE + "' is deprecated " +
                     "for a KWIC <DataView>, please use '" +
-                    KWIC_TYPE + "' instead");
+                    LegacyDataViewKWIC.TYPE + "' instead");
         }
         String left = null;
@@ -81 +89 @@
         logger.debug("left='{}' keyword='{}', right='{}'",
                 left, keyword, right);
-
-        logger.warn("Upgraded deprecated KWIC dataview to HITS dataview. " +
-                "Please upgrade to the new CLARIN-FCS specification " +
-                "as soon as possible.");
-        final int[] offsets    = new int[3];
-        final StringBuilder sb = new StringBuilder();
-        if (left != null) {
-            sb.append(left);
-            if (!Character.isWhitespace(sb.charAt(sb.length() - 1))) {
-                sb.append(" ");
+        if (fullLegacyCompatMode) {
+            return new LegacyDataViewKWIC(pid, ref, left, keyword, right);
+        } else {
+            logger.warn("Upgraded deprecated KWIC dataview to HITS dataview. " +
+                    "Please upgrade to the new CLARIN-FCS specification " +
+                    "as soon as possible.");
+            final int[] offsets = new int[3];
+            final StringBuilder sb = new StringBuilder();
+            if (left != null) {
+                sb.append(left);
+                if (!Character.isWhitespace(sb.charAt(sb.length() - 1))) {
+                    sb.append(" ");
+                }
             }
+            offsets[0] = sb.length();
+            sb.append(keyword);
+            offsets[1] = sb.length();
+            if (right != null) {
+                if (!Character.isWhitespace(sb.charAt(sb.length() - 1))) {
+                    sb.append(" ");
+                }
+                sb.append(right);
+            }
+            return new DataViewHits(pid, ref, sb.toString(), offsets, 3);
         }
-        offsets[0] = sb.length();
-        sb.append(keyword);
-        offsets[1] = sb.length();
-        if (right != null) {
-            if (!Character.isWhitespace(sb.charAt(sb.length() - 1))) {
-                sb.append(" ");
-            }
-            sb.append(right);
-        }
-        return new DataViewHits(pid, ref, sb.toString(), offsets, 3);
     }
 

FCSSimpleClient/trunk/src/main/java/eu/clarin/sru/client/fcs/LegacyClarinFCSRecordDataParser.java

@@ -35 +35 @@
 public class LegacyClarinFCSRecordDataParser extends
         AbstractClarinFCSRecordDataParser {
+    private final boolean fullLegacyCompatMode;
 
-
+    
     /**
      * Constructor.
@@ -45 +46 @@
      *            {@link DataViewParserGenericDOM} or
      *            {@link DataViewParserGenericString} instance.
+     * @param fullLegacyCompatMode
+     *            enable full legacy CLARIN-FCS compat mode
      * @throws NullPointerException
      *             if parsers is <code>null</code>
@@ -50 +53 @@
      *             if parsers is empty or contains duplicate entries
      */
-    public LegacyClarinFCSRecordDataParser(List<DataViewParser> parsers) {
+    public LegacyClarinFCSRecordDataParser(List<DataViewParser> parsers,
+            boolean fullLegacyCompatMode) {
         super(parsers);
+        this.fullLegacyCompatMode = fullLegacyCompatMode;
     }
 
@@ -57 +62 @@
     @Override
     public String getRecordSchema() {
-        return ClarinFCSRecordData.LEGACY_RECORD_SCHEMA;
+        return LegacyClarinFCSRecordData.RECORD_SCHEMA;
     }
 
@@ -64 +69 @@
     public SRURecordData parse(XMLStreamReader reader)
             throws XMLStreamException, SRUClientException {
-        logger.warn("The endpoint supplied data in the deprecated CLARIN-FCS " +
-            "record data format. Please upgrade to the new CLARIN-FCS " +
-                "specification as soon as possible.");
-        return parse(reader, ClarinFCSRecordData.LEGACY_RECORD_SCHEMA);
+        if (!fullLegacyCompatMode) {
+            logger.warn("The endpoint supplied data in the deprecated " +
+                    "CLARIN-FCS record data format. Please upgrade to the " +
+                    "new CLARIN-FCS specification as soon as possible.");
+        }
+        return parse(reader, LegacyClarinFCSRecordData.RECORD_SCHEMA,
+                fullLegacyCompatMode);
     }