Changeset 5477

Timestamp:

07/11/14 15:29:52 (10 years ago)

Author:

margaretha@ids-mannheim.de

Message:

Added endpoint description,
updated SimpleResourceInfoInventory? according to the new format.

Location:

FCSSimpleEndpoint/trunk

Files:

• pom.xml (modified) (1 diff)
• src/main/java/eu/clarin/sru/server/fcs/DataView.java (added)
• src/main/java/eu/clarin/sru/server/fcs/EndpointDescriptionWriter.java (added)
• src/main/java/eu/clarin/sru/server/fcs/ResourceInfo.java (modified) (6 diffs)
• src/main/java/eu/clarin/sru/server/fcs/ResourceInfoWriter.java (added)
• src/main/java/eu/clarin/sru/server/fcs/SimpleEndpointSearchEngineBase.java (modified) (13 diffs)
• src/main/java/eu/clarin/sru/server/fcs/SimpleFcsResourceWriter.java (moved) (moved from FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/FCSResultWriter.java) (1 diff)
• src/main/java/eu/clarin/sru/server/fcs/utils/SimpleResourceInfoInventoryParser.java (modified) (7 diffs)

FCSSimpleEndpoint/trunk/pom.xml

@@ -4 +4 @@
     <groupId>eu.clarin.sru.fcs</groupId>
     <artifactId>fcs-simple-endpoint</artifactId>
-    <version>1.3.0-SNAPSHOT</version>
+    <version>2.0-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>A simple CLARIN FCS endpoint</name>

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/ResourceInfo.java

@@ -14 +14 @@
 public class ResourceInfo {
     private final String pid;
+    @Deprecated
     private final int resourceCount;
     private final Map<String, String> title;
@@ -19 +20 @@
     private final String landingPageURI;
     private final List<String> languages;
+    private final List<String> availableDataViews;
     private List<ResourceInfo> subResources;
-
+    
 
     /**
@@ -50 +52 @@
             Map<String, String> title, Map<String, String> description,
             String landingPageURI, List<String> languages,
+            List<String> availableDataViews,
             List<ResourceInfo> subResources) {
         if (pid == null) {
@@ -76 +79 @@
         }
         this.languages = languages;
+        if (availableDataViews == null){
+                throw new IllegalArgumentException("available data views == null");
+        }
+        if (availableDataViews.isEmpty()){
+                throw new IllegalArgumentException("available data views are empty");
+        }
+        this.availableDataViews = availableDataViews;
         if ((subResources != null) && !subResources.isEmpty()) {
             this.subResources = Collections.unmodifiableList(subResources);
         } else {
             this.subResources = null;
-        }
+        }        
     }
 
@@ -101 +111 @@
      * @return a number of items or <code>-1</code> if not applicable
      */
+    @Deprecated
     public int getResourceCount() {
         return resourceCount;
@@ -196 +207 @@
     }
 
+
+        public List<String> getAvailableDataViews() {
+                return availableDataViews;
+        }
+
+
 } // class ResourceInfo

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/SimpleEndpointSearchEngineBase.java

@@ -1 +1 @@
 package eu.clarin.sru.server.fcs;
 
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -6 +7 @@
 
 import javax.servlet.ServletContext;
-import javax.xml.XMLConstants;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
@@ -36 +36 @@
 public abstract class SimpleEndpointSearchEngineBase extends
         SRUSearchEngineBase {
-    private static final String FCS_RESOURCE_INFO_NS =
-            "http://clarin.eu/fcs/1.0/resource-info";
-    private static final String X_CMD_RESOURCE_INFO = "x-cmd-resource-info";
+    
+//    private static final String X_CMD_RESOURCE_INFO = "x-cmd-resource-info";
+    private static final String X_FCS_ENDPOINT_DESCRIPTION = "x-fcs-endpoint-description";
+    
     private static final String FCS_SCAN_INDEX_FCS_RESOURCE = "fcs.resource";
     private static final String FCS_SCAN_INDEX_CQL_SERVERCHOICE = "cql.serverChoice";
@@ -47 +48 @@
             LoggerFactory.getLogger(SimpleEndpointSearchEngineBase.class);
     protected ResourceInfoInventory resourceInfoInventory;
-
-
-    /**
+    
+    public List<String> capabilities;
+    public List<DataView> supportedDataViews;
+    
+    public void addEndpointCapability(String c){
+        capabilities.add(c);
+    }
+    
+    public void addDataView(DataView d){
+        supportedDataViews.add(d);
+    }
+        
+        /**
      * This method should not be overridden. Perform your custom initialization
      * in the {@link #doInit(ServletContext, SRUServerConfig, Map)} method
@@ -61 +72 @@
         logger.debug("initializing");
         super.init(context, config, params);
-
+        
+        logger.debug("Setting basic capability");
+        capabilities = new ArrayList<String>();
+        capabilities.add("http://clarin.eu/fcs/capability/basic-search");
+        
+        logger.debug("Setting Generic Hits dataview");
+        supportedDataViews = new ArrayList<DataView>();
+        supportedDataViews.add(
+                        new DataView("The representation of the hit", 
+                                "application/x-clarin-fcs-hits+xml", 
+                                DataView.PayloadDisposition.INLINE, 
+                                DataView.PayloadDelivery.SEND_BY_DEFAULT, 
+                                "hits")
+        );
+        
         logger.debug("initializing search engine implementation");
         doInit(context, config, params);
-
+                
         logger.debug("initizalizing resource info inventory");
         this.resourceInfoInventory = createResourceInfoInventory(context, config, params);
@@ -97 +122 @@
             throws SRUException {
         final boolean provideResourceInfo =
-                parseBoolean(request.getExtraRequestData(X_CMD_RESOURCE_INFO));
+                parseBoolean(request.getExtraRequestData(X_FCS_ENDPOINT_DESCRIPTION));
         if (provideResourceInfo) {
             final List<ResourceInfo> resourceInfoList =
@@ -112 +137 @@
                 public void writeExtraResponseData(XMLStreamWriter writer)
                         throws XMLStreamException {
-                    writeFullResourceInfo(writer, null, resourceInfoList);
+                        EndpointDescriptionWriter.writeEndpointDescription(writer, 
+                                        capabilities, supportedDataViews, resourceInfoList);
+                    //ResourceInfoWriter.writeFullResourceInfo(writer, null, resourceInfoList);
                 }
             };
@@ -130 +157 @@
      */
     @Override
+    @Deprecated
     public final SRUScanResultSet scan(SRUServerConfig config,
             SRURequest request, SRUDiagnosticList diagnostics)
@@ -153 +181 @@
              */
             final boolean provideResourceInfo = parseBoolean(
-                    request.getExtraRequestData(X_CMD_RESOURCE_INFO));
+                    request.getExtraRequestData(X_FCS_ENDPOINT_DESCRIPTION));
 
             return new SRUScanResultSet(diagnostics) {
@@ -198 +226 @@
                         throws XMLStreamException {
                     if (provideResourceInfo) {
-                        writeResourceInfo(writer, null, result.get(idx));
+                        ResourceInfoWriter.writeResourceInfo(writer, null, result.get(idx));
                     }
                 }
@@ -266 +294 @@
      *      SRUDiagnosticList)
      */
+    @Deprecated
     protected SRUScanResultSet doScan(SRUServerConfig config,
             SRURequest request, SRUDiagnosticList diagnostics)
@@ -301 +330 @@
     }
 
-
+    @Deprecated
     private List<ResourceInfo> translateFcsScanResource(CQLNode scanClause)
             throws SRUException {
@@ -373 +402 @@
 
 
-    private static void writeFullResourceInfo(XMLStreamWriter writer,
-            String prefix, List<ResourceInfo> resourceInfoList)
-            throws XMLStreamException {
-        if (resourceInfoList == null) {
-            throw new NullPointerException("resourceInfoList == null");
-        }
-        if (!resourceInfoList.isEmpty()) {
-            final boolean defaultNS = ((prefix == null) || prefix.isEmpty());
-            if (defaultNS) {
-                writer.setDefaultNamespace(FCS_RESOURCE_INFO_NS);
-            } else {
-                writer.setPrefix(prefix, FCS_RESOURCE_INFO_NS);
-            }
-            writer.writeStartElement(FCS_RESOURCE_INFO_NS, "ResourceCollection");
-            if (defaultNS) {
-                writer.writeDefaultNamespace(FCS_RESOURCE_INFO_NS);
-            } else {
-                writer.writeNamespace(prefix, FCS_RESOURCE_INFO_NS);
-            }
-            for (ResourceInfo resourceInfo : resourceInfoList) {
-                doWriteResourceInfo(writer, prefix, resourceInfo, false, true);
-            }
-            writer.writeEndElement(); // "ResourceCollection" element
-        }
-    }
-
-
-    private static void writeResourceInfo(XMLStreamWriter writer, String prefix,
-            ResourceInfo resourceInfo) throws XMLStreamException {
-        if (resourceInfo == null) {
-            throw new NullPointerException("resourceInfo == null");
-        }
-        doWriteResourceInfo(writer, prefix, resourceInfo, true, false);
-    }
-
-
-    private static void doWriteResourceInfo(XMLStreamWriter writer,
-            String prefix, ResourceInfo resourceInfo, boolean writeNS,
-            boolean recursive) throws XMLStreamException {
-        final boolean defaultNS = ((prefix == null) || prefix.isEmpty());
-        if (writeNS) {
-            if (defaultNS) {
-                writer.setDefaultNamespace(FCS_RESOURCE_INFO_NS);
-            } else {
-                writer.setPrefix(prefix, FCS_RESOURCE_INFO_NS);
-            }
-        }
-        writer.writeStartElement(FCS_RESOURCE_INFO_NS, "ResourceInfo");
-        if (writeNS) {
-            if (defaultNS) {
-                writer.writeDefaultNamespace(FCS_RESOURCE_INFO_NS);
-            } else {
-                writer.writeNamespace(prefix, FCS_RESOURCE_INFO_NS);
-            }
-        }
-        if (recursive) {
-            /*
-             * HACK: only output @pid for recursive (= explain) requests.
-             * This should be revisited, if we decide to go for the explain
-             * style enumeration of resources.
-             */
-            writer.writeAttribute("pid", resourceInfo.getPid());
-        }
-        if (resourceInfo.hasSubResources()) {
-            writer.writeAttribute("hasSubResources", "true");
-        }
-
-        final Map<String, String> title = resourceInfo.getTitle();
-        for (Map.Entry<String, String> i : title.entrySet()) {
-            writer.setPrefix(XMLConstants.XML_NS_PREFIX,
-                    XMLConstants.XML_NS_URI);
-            writer.writeStartElement(FCS_RESOURCE_INFO_NS, "Title");
-            writer.writeAttribute(XMLConstants.XML_NS_URI, "lang", i.getKey());
-            writer.writeCharacters(i.getValue());
-            writer.writeEndElement(); // "title" element
-        }
-
-        final Map<String, String> description = resourceInfo.getDescription();
-        if (description != null) {
-            for (Map.Entry<String, String> i : description.entrySet()) {
-                writer.writeStartElement(FCS_RESOURCE_INFO_NS, "Description");
-                writer.writeAttribute(XMLConstants.XML_NS_URI, "lang",
-                        i.getKey());
-                writer.writeCharacters(i.getValue());
-                writer.writeEndElement(); // "Description" element
-            }
-        }
-
-        final String landingPageURI = resourceInfo.getLandingPageURI();
-        if (landingPageURI != null) {
-            writer.writeStartElement(FCS_RESOURCE_INFO_NS, "LandingPageURI");
-            writer.writeCharacters(landingPageURI);
-            writer.writeEndElement(); // "LandingPageURI" element
-        }
-
-        final List<String> languages = resourceInfo.getLanguages();
-        writer.writeStartElement(FCS_RESOURCE_INFO_NS, "Languages");
-        for (String i : languages) {
-            writer.writeStartElement(FCS_RESOURCE_INFO_NS, "Language");
-            writer.writeCharacters(i);
-            writer.writeEndElement(); // "Language" element
-
-        }
-        writer.writeEndElement(); // "Languages" element
-
-        if (recursive && resourceInfo.hasSubResources()) {
-            writer.writeStartElement(FCS_RESOURCE_INFO_NS,
-                    "ResourceInfoCollection");
-            for (ResourceInfo r : resourceInfo.getSubResources()) {
-                doWriteResourceInfo(writer, prefix, r, writeNS, recursive);
-            }
-            writer.writeEndElement(); // "ResourceCollection" element
-        }
-        writer.writeEndElement(); // "ResourceInfo" element
-    }
+    
 
 } // class SimpleEndpointSearchEngineBase

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/SimpleFcsResourceWriter.java

@@ -4 +4 @@
 import javax.xml.stream.XMLStreamWriter;
 
-public class FCSResultWriter {
+public class SimpleFcsResourceWriter {
         private static final String FCS_NS = "http://clarin.eu/fcs/resource";
     private static final String FCS_PREFIX = "fcs";

FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/utils/SimpleResourceInfoInventoryParser.java

@@ -4 +4 @@
 import java.net.URL;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -27 +28 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
+import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import org.xml.sax.SAXException;
@@ -44 +46 @@
  */
 public class SimpleResourceInfoInventoryParser {
-    private static final String NS = "http://clarin.eu/fcs/1.0/resource-info";
+    private static final String NS = "http://clarin.eu/fcs/endpoint-description";
     private static final String LANG_EN = "en";
     private static final Logger logger =
@@ -103 +105 @@
             });
             XPathExpression expression =
-                    xpath.compile("/ri:ResourceCollection/ri:ResourceInfo");
+                    xpath.compile("/ri:Resources/ri:Resource");
             NodeList list =
                     (NodeList) expression.evaluate(doc, XPathConstants.NODESET);
@@ -137 +139 @@
             String link = null;
             List<String> langs = null;
+            String[] availableDataViews = null;
             List<ResourceInfo> sub = null;
 
@@ -262 +265 @@
                 }
             }
-
+            
+            XPathExpression x6 = xpath.compile("ri:AvailableDataViews/@ref");
+            String ref = (String) x6.evaluate(node, XPathConstants.STRING);
+            
+            if (ref == null || ref.isEmpty()){
+                throw new SRUConfigException("Element <AvailableDataViews> " +
+                        "must have a non-empty attribute ref.");
+            }
+            
+            availableDataViews = ref.split("\\s+");
+            
+            
             XPathExpression x5 =
-                    xpath.compile("ri:ResourceCollection/ri:ResourceInfo");
+                    xpath.compile("ri:Resources/ri:Resource");
             NodeList l5 = (NodeList) x5.evaluate(node, XPathConstants.NODESET);
             if ((l5 != null) && (l5.getLength() > 0)) {
@@ -274 +288 @@
             }
             ris.add(new ResourceInfo(pid, resourceCount, titles, descrs, link,
-                    langs, sub));
+                    langs, Arrays.asList(availableDataViews),sub));
         }
         return ris;