Changeset 5485

Timestamp:

07/23/14 13:34:48 (10 years ago)

Author:

margaretha@ids-mannheim.de

Message:

Enabled x-cmd-resource-info

Location:

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

Files:

• ResourceInfo.java (modified) (4 diffs)
• ResourceInfoWriter.java (modified) (2 diffs)
• SimpleEndpointSearchEngineBase.java (modified) (4 diffs)

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

@@ -20 +20 @@
     private final String landingPageURI;
     private final List<String> languages;
-    private final List<String> availableDataViews;
+    private List<String> availableDataViews;
     private List<ResourceInfo> subResources;
     
@@ -52 +52 @@
             Map<String, String> title, Map<String, String> description,
             String landingPageURI, List<String> languages,
-            List<String> availableDataViews,
             List<ResourceInfo> subResources) {
         if (pid == null) {
@@ -79 +78 @@
         }
         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);
@@ -93 +86 @@
     }
 
+    public ResourceInfo(String pid, int resourceCount,
+            Map<String, String> title, Map<String, String> description,
+            String landingPageURI, List<String> languages,
+            List<String> availableDataViews,
+            List<ResourceInfo> subResources) {
+        this(pid,resourceCount, title, description, landingPageURI, languages, subResources);
+        
+        if (availableDataViews == null){
+                throw new IllegalArgumentException("available data views == null");
+        }
+        if (availableDataViews.isEmpty()){
+                throw new IllegalArgumentException("available data views are empty");
+        }
+        this.availableDataViews = availableDataViews;        
+    }
+    
 
     /**

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

@@ -53 +53 @@
                 if (writer == null) {
             throw new NullPointerException("writer == null");
-        }
-                if (prefix == null) {
-            throw new NullPointerException("prefix == null");
-        }
-                if (prefix.isEmpty()) {
-            throw new IllegalArgumentException("prefix is empty");
-        }
+        }               
                 if (resourceInfo == null) {
             throw new NullPointerException("resourceInfo == null");
@@ -129 +123 @@
         }
         writer.writeEndElement(); // "Languages" element
-
-        final List<String> availableDataViews = resourceInfo.getAvailableDataViews();
-        writer.writeStartElement(FCS_RESOURCE_INFO_NS, "AvailableDataViews");
         
-        StringBuilder sb = new StringBuilder();
-        for (int i = 0; i < availableDataViews.size(); i++) {
-            sb.append(availableDataViews.get(i));
-            sb.append(" ");
-        }        
-        writer.writeAttribute("ref", sb.toString().trim());
-        
-        writer.writeEndElement(); // "Languages" element
-
+        if (!defaultNS && prefix.equals(EndpointDescriptionWriter.PREFIX)){
+                final List<String> availableDataViews = resourceInfo.getAvailableDataViews();
+                writer.writeStartElement(FCS_RESOURCE_INFO_NS, "AvailableDataViews");
+                
+                StringBuilder sb = new StringBuilder();
+                for (int i = 0; i < availableDataViews.size(); i++) {
+                    sb.append(availableDataViews.get(i));
+                    sb.append(" ");
+                }        
+                writer.writeAttribute("ref", sb.toString().trim());
+                
+                writer.writeEndElement(); // "AvailableDataViews" element
+        }
         
         if (recursive && resourceInfo.hasSubResources()) {

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

@@ -37 +37 @@
         SRUSearchEngineBase {
     
-//    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";
     
@@ -58 +58 @@
     public void addDataView(DataView d){
         supportedDataViews.add(d);
-    }
-        
+    }   
+       
+    public void setCapabilities(){
+         logger.debug("Setting basic capability");
+         capabilities = new ArrayList<String>();
+         capabilities.add("http://clarin.eu/fcs/capability/basic-search");
+    }      
+    
+    public void setSupportedDataViews(){
+         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")
+         );
+    }
+    
         /**
      * This method should not be overridden. Perform your custom initialization
@@ -71 +89 @@
             Map<String, String> params) throws SRUConfigException {
         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")
-        );
+        super.init(context, config, params);              
         
         logger.debug("initializing search engine implementation");
@@ -121 +125 @@
             SRURequest request, SRUDiagnosticList diagnostics)
             throws SRUException {
-        final boolean provideResourceInfo =
+        
+        final boolean provideCmdResourceInfo =
+                parseBoolean(request.getExtraRequestData(X_CMD_RESOURCE_INFO));
+        final boolean provideFcsResourceInfo =
                 parseBoolean(request.getExtraRequestData(X_FCS_ENDPOINT_DESCRIPTION));
-        if (provideResourceInfo) {
+                
+        if (provideCmdResourceInfo) {
             final List<ResourceInfo> resourceInfoList =
                     resourceInfoInventory.getResourceInfoList(
                             ResourceInfoInventory.PID_ROOT);
+            
             return new SRUExplainResult(diagnostics) {
-
                 @Override
                 public boolean hasExtraResponseData() {
-                    return provideResourceInfo;
-                }
-
+                    return provideCmdResourceInfo;
+                }
                 @Override
                 public void writeExtraResponseData(XMLStreamWriter writer)
                         throws XMLStreamException {
-                        EndpointDescriptionWriter.writeEndpointDescription(writer, 
-                                        capabilities, supportedDataViews, resourceInfoList);
-                    //ResourceInfoWriter.writeFullResourceInfo(writer, null, resourceInfoList);
+                    ResourceInfoWriter.writeFullResourceInfo(writer, null, resourceInfoList);
                 }
             };
-        } else {
+        }
+        else if (provideFcsResourceInfo && capabilities != null 
+                        && supportedDataViews != null){
+                
+                final List<ResourceInfo> resourceInfoList =
+                    resourceInfoInventory.getResourceInfoList(
+                            ResourceInfoInventory.PID_ROOT);
+                
+//              if (capabilities == null){
+//                      throw new SRUException(SRUConstants.SRU_GENERAL_SYSTEM_ERROR, 
+//                                      "Capabilities are not set.");
+//              }
+//              if (supportedDataViews == null){
+//                      throw new SRUException(SRUConstants.SRU_GENERAL_SYSTEM_ERROR, 
+//                                      "Supported data views are not set.");
+//              }
+                return new SRUExplainResult(diagnostics) {
+                @Override
+                public boolean hasExtraResponseData() {
+                    return provideFcsResourceInfo;
+                }
+                @Override
+                public void writeExtraResponseData(XMLStreamWriter writer)
+                        throws XMLStreamException {
+                        EndpointDescriptionWriter.writeEndpointDescription(writer, 
+                                capabilities, supportedDataViews, resourceInfoList);
+                }
+            };
+        }
+        else {
             return null;
         }