Changeset 5546 for FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/utils/SimpleEndpointDescription.java

Timestamp:

08/09/14 20:45:17 (10 years ago)

Author:

Oliver Schonefeld

Message:

• support new FCS specification (with some backwards compatibility for old spec)

HEADS UP: not yet ready for release; needs more testing

File:

• FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/utils/SimpleEndpointDescription.java (moved) (moved from FCSSimpleEndpoint/trunk/src/main/java/eu/clarin/sru/server/fcs/utils/SimpleResourceInfoInventory.java) (4 diffs)

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

@@ -1 +1 @@
 package eu.clarin.sru.server.fcs.utils;
 
+import java.net.URI;
 import java.util.Collections;
 import java.util.List;
 
-import eu.clarin.sru.server.fcs.ResourceInfoInventory;
+import eu.clarin.sru.server.SRUException;
+import eu.clarin.sru.server.fcs.DataView;
+import eu.clarin.sru.server.fcs.EndpointDescription;
 import eu.clarin.sru.server.fcs.ResourceInfo;
 
 
 /**
- * A very simple resource info inventory that is initialized with a static list
- * of resource info records. Mostly used together with
- * {@link SimpleResourceInfoInventoryParser}, but it is agnostic how the static
- * list of resource info records is generated.
- * 
- * @see ResourceInfoInventory
- * @see SimpleResourceInfoInventoryParser
+ * A very simple implementation of an endpoint description that is initialized
+ * from static information supplied at construction time. Mostly used together
+ * with {@link SimpleEndpointDescriptionParser}, but it is agnostic how the
+ * static list of resource info records is generated.
+ *
+ * @see EndpointDescription
+ * @see SimpleEndpointDescriptionParser
  */
-public class SimpleResourceInfoInventory implements ResourceInfoInventory {
+public class SimpleEndpointDescription extends AbstractEndpointDescriptionBase {
     private final boolean pidCaseSensitive;
     private final List<ResourceInfo> entries;
@@ -25 +28 @@
      * Constructor.
      *
-     * @param entries
+     * @param capabilities
+     *            a list of capabilities supported by this endpoint
+     * @param supportedDataViews
+     *            a list of data views that are supported by this endpoint
+     * @param resources
      *            a static list of resource info records
      * @param pidCaseSensitive
      *            <code>true</code> if comparison of persistent identifiers
-     *            should be performed case-sensitive, <code>false</code> otherwise
+     *            should be performed case-sensitive, <code>false</code>
+     *            otherwise
      */
-    public SimpleResourceInfoInventory(List<ResourceInfo> entries,
+    public SimpleEndpointDescription(List<URI> capabilities,
+            List<DataView> supportedDataViews, List<ResourceInfo> resources,
             boolean pidCaseSensitive) {
-        if (entries == null) {
+        super(capabilities, supportedDataViews);
+
+        if (resources == null) {
             throw new NullPointerException("entries == null");
         }
-        this.entries = Collections.unmodifiableList(entries);
+        this.entries = Collections.unmodifiableList(resources);
         this.pidCaseSensitive = pidCaseSensitive;
     }
@@ -47 +58 @@
 
     @Override
-    public List<ResourceInfo> getResourceInfoList(String id) {
-        if (id == null) {
-            throw new NullPointerException("id == null");
+    public List<ResourceInfo> getResourceList(String pid) throws SRUException {
+        if (pid == null) {
+            throw new NullPointerException("pid == null");
         }
-        if (id.isEmpty()) {
-            throw new IllegalArgumentException("id is empty");
+        if (pid.isEmpty()) {
+            throw new IllegalArgumentException("pid is empty");
         }
         if (!pidCaseSensitive) {
-            id = id.toLowerCase();
+            pid = pid.toLowerCase();
         }
-        if (id.equals(PID_ROOT)) {
+        if (pid.equals(PID_ROOT)) {
             return entries;
         } else {
-            ResourceInfo ri = findRecursive(entries, id);
+            ResourceInfo ri = findRecursive(entries, pid);
             if (ri != null) {
                 return ri.getSubResources();
@@ -93 +104 @@
     }
 
-} // class SimpleResourceInfoInventory
+} // class SimpleEndpointDescription