Changeset 2348

Timestamp:

11/13/12 09:30:49 (12 years ago)

Author:

twagoo

Message:

Updated branch with changes in trunk
Fixes #223

Location:

ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/ComponentRegistry

Files:

• . (modified) (1 prop)
• src/main/binding (modified) (1 prop)
• src/main/java (modified) (1 prop)
• src/main/java/clarin/cmdi/componentregistry/CMDComponentSpecExpander.java (modified) (1 diff)
• src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java (modified) (3 diffs)
• src/main/java/clarin/cmdi/componentregistry/rest/MDValidator.java (modified) (8 diffs)
• src/main/webresources/WEB-INF/spring-config/component-registry.xml (modified) (1 diff)
• src/test/java (modified) (1 prop)
• src/test/java/clarin/cmdi/componentregistry/rest/MDValidatorTest.java (modified) (3 diffs)

ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/CMDComponentSpecExpander.java

@@ -26 +26 @@
     public void expandNestedComponent(List<CMDComponentType> cmdComponents, String id) throws ComponentRegistryException {
         expandNestedComponent(cmdComponents, new HashSet<String>(Collections.singleton(id)));
-    }
-
-    public void expandNestedComponent(List<CMDComponentType> cmdComponents) throws ComponentRegistryException {
-        expandNestedComponent(cmdComponents, new HashSet<String>());
     }
 

ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java

@@ -85 +85 @@
      * ComponentStatus
      *
+     *
      * @param userSpace
      * @return
@@ -809 +810 @@
 
                 try {
-                    // Expand to check for recursion (todo: run on copy or do a dry-run so that the actual spec does not get expanded)
-                    registry.getExpander().expandNestedComponent(spec.getCMDComponent(), desc.getId());
+                    checkForRecursion(validator, registry, desc);
 
                     // Add profile
@@ -838 +838 @@
                 LOG.error("Error when closing inputstream: ", e);
             }
+        }
+    }
+
+    /**
+     *
+     * @param validator
+     * @param registry
+     * @param desc
+     * @throws ComponentRegistryException if recursion is detected or something goes wrong while trying to detect recursion
+     */
+    private void checkForRecursion(MDValidator validator, ComponentRegistry registry, AbstractDescription desc) throws ComponentRegistryException {
+        try {
+            // Expand to check for recursion. Operate on copy so that original does not get expanded.
+            final CMDComponentSpec specCopy = validator.getCopyOfCMDComponentSpec();
+            // In case of recursion, the following will throw a ComponentRegistryException
+            registry.getExpander().expandNestedComponent(specCopy.getCMDComponent(), desc.getId());
+        } catch (JAXBException ex) {
+            throw new ComponentRegistryException("Unmarshalling failed while preparing recursion detection", ex);
         }
     }

ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/MDValidator.java

@@ -29 +29 @@
 
 public class MDValidator implements Validator {
-    
+
     private final static Logger LOG = LoggerFactory.getLogger(MDValidator.class);
     static final String MISMATCH_ERROR = "Cannot register component as a profile or vica versa.";
@@ -43 +43 @@
     private List<String> errorMessages = new ArrayList<String>();
     private CMDComponentSpec spec = null;
+    private byte[] originalSpecBytes;
     private final InputStream input;
     private final AbstractDescription description;
@@ -65 +66 @@
         this.publicRegistry = publicRegistry;
     }
-    
+
     @Override
     public List<String> getErrorMessages() {
         return errorMessages;
     }
-    
+
     @Override
     public boolean validate() {
@@ -77 +78 @@
             validator.setResourceResolver(new ComponentRegistryResourceResolver());
             // We may need to reuse the input stream, so save it to a byte array first
-            byte[] inputBytes = getBytesFromInputStream();
-            StreamSource source = new StreamSource(new ByteArrayInputStream(inputBytes));
+            originalSpecBytes = getBytesFromInputStream();
+            StreamSource source = new StreamSource(new ByteArrayInputStream(originalSpecBytes));
             if (!validator.validateProfile(source)) {
                 final List<Message> validatorMessages = validator.getMessages();
@@ -89 +90 @@
                 }
             } else {
-                spec = MDMarshaller.unmarshal(CMDComponentSpec.class, new ByteArrayInputStream(inputBytes), null);
+                spec = unmarshalSpec(originalSpecBytes);
                 if (spec.isIsProfile() != description.isProfile()) {
                     errorMessages.add(MISMATCH_ERROR);
@@ -113 +114 @@
         return errorMessages.isEmpty();
     }
-    
+
     private byte[] getBytesFromInputStream() throws IOException {
         int len;
         byte[] b = new byte[4096];
         final ByteArrayOutputStream bOS = new ByteArrayOutputStream();
-        
+
         while ((len = input.read(b)) > 0) {
             bOS.write(b, 0, len);
         }
-        
+
         return bOS.toByteArray();
     }
-    
+
     private void validateComponents(List<CMDComponentType> cmdComponents) throws ComponentRegistryException {
         for (CMDComponentType cmdComponentType : cmdComponents) {
@@ -132 +133 @@
         }
     }
-    
+
     private void validateDescribedComponents(CMDComponentType cmdComponentType) throws ComponentRegistryException {
         checkPublicComponents(cmdComponentType);
     }
-    
+
     private void checkPublicComponents(CMDComponentType cmdComponentType) throws ComponentRegistryException {
         if (isDefinedInSeparateFile(cmdComponentType)) {
@@ -161 +162 @@
                     }
                 }
-                
+
             }
         }
     }
-    
+
     private boolean isDefinedInSeparateFile(CMDComponentType cmdComponentType) {
         return cmdComponentType.getName() == null;
     }
-    
+
+    /**
+     * Do not call before having called {@link #validate() }!
+     *
+     * @return the spec unmarshalled during {@link #validate() }. If this has not been called, returns null.
+     */
     public CMDComponentSpec getCMDComponentSpec() {
         return spec;
     }
+
+    /**
+     * Creates a fresh (re-unmarshalled) copy of the specification this instance has validated. If you are not going to alter this copy,
+     * you can re-use and share the copy used during validation by getting it from {@link #getCMDComponentSpec() }.
+     * <em>Do not call before having called {@link #validate() }!</em>
+     *
+     * @return a freshly unmarshalled copy of the spec based on the bytes collected from the input stream passed to {@link #validate() }.
+     * If this has not been called, returns null.
+     * @throws JAXBException exception occurred while marshalling from the input bytes
+     * @see #validate()
+     * @see #getCMDComponentSpec()
+     */
+    public CMDComponentSpec getCopyOfCMDComponentSpec() throws JAXBException {
+        // Re-unmarshall original bytes
+        return unmarshalSpec(originalSpecBytes);
+    }
+
+    private static CMDComponentSpec unmarshalSpec(byte[] inputBytes) throws JAXBException {
+        return MDMarshaller.unmarshal(CMDComponentSpec.class, new ByteArrayInputStream(inputBytes), null);
+    }
 }

ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/ComponentRegistry/src/main/webresources/WEB-INF/spring-config/component-registry.xml

@@ -17 +17 @@
         <property name="component2SchemaXsl" value="http://www.clarin.eu/cmd/xslt/comp2schema-v2/comp2schema.xsl"/>
         <property name="componentSpecSchemaLocation" value="http://www.clarin.eu/cmd http://www.clarin.eu/cmd/general-component-schema.xsd" />
-        <property name="isocatRestUrl" value="http://www.isocat.org/rest/" />
+        <!-- TODO: Read the following from a context parameter -->
+        <property name="isocatRestUrl" value="https://catalog.clarin.eu/isocat/rest/" />
     <!-- Extra attribute keys that are passed in a shibboleth authenticated request principal.
          You need to configure the shhaa.xml file to enable the extra attributes.

ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/ComponentRegistry/src/test/java/clarin/cmdi/componentregistry/rest/MDValidatorTest.java

@@ -4 +4 @@
 import clarin.cmdi.componentregistry.ComponentRegistryFactory;
 import clarin.cmdi.componentregistry.ComponentStatus;
+import clarin.cmdi.componentregistry.components.CMDComponentSpec;
 import clarin.cmdi.componentregistry.impl.database.ComponentRegistryTestDatabase;
 import clarin.cmdi.componentregistry.model.ComponentDescription;
@@ -37 +38 @@
     @Test
     public void testValidateSucces() {
-        String profileContent = "";
-        profileContent += "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
-        profileContent += "<CMD_ComponentSpec isProfile=\"true\" xmlns:xml=\"http://www.w3.org/XML/1998/namespace\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
-        profileContent += "    xsi:noNamespaceSchemaLocation=\"general-component-schema.xsd\">\n";
-        profileContent += "    <Header />\n";
-        profileContent += "    <CMD_Component name=\"Actor\" CardinalityMin=\"0\" CardinalityMax=\"unbounded\">\n";
-        profileContent += "        <CMD_Element name=\"Age\">\n";
-        profileContent += "            <ValueScheme>\n";
-        profileContent += "                <pattern>[23][0-9]</pattern>\n";
-        profileContent += "            </ValueScheme>\n";
-        profileContent += "        </CMD_Element>\n";
-        profileContent += "    </CMD_Component>\n";
-        profileContent += "</CMD_ComponentSpec>\n";
-        InputStream input = new ByteArrayInputStream(profileContent.getBytes());
-
-        ProfileDescription desc = ProfileDescription.createNewDescription();
-        MDValidator validator = new MDValidator(input, desc, publicRegistry, null, publicRegistry);
+        MDValidator validator = getValidProfileValidator();
         assertTrue(validator.validate());
     }
@@ -222 +207 @@
         assertTrue(validator.validate());
         assertEquals(0, validator.getErrorMessages().size());
-
+    }
+
+    /**
+     * Test of getCMDComponentSpec method, of class MDValidator.
+     */
+    @Test
+    public void testGetCMDComponentSpec() throws Exception {
+        String profileContent = getValidProfileString();
+        InputStream input = new ByteArrayInputStream(profileContent.getBytes());
+
+        ProfileDescription desc = ProfileDescription.createNewDescription();
+        MDValidator validator = new MDValidator(input, desc, publicRegistry, null, publicRegistry);
+
+        // Spec is created during validation, before it should be null
+        assertNull(validator.getCMDComponentSpec());
+        validator.validate();
+
+        // Get spec created during validation
+        final CMDComponentSpec cmdComponentSpec = validator.getCMDComponentSpec();
+        assertNotNull(cmdComponentSpec);
+
+        // Spec content should match XML
+        assertTrue(cmdComponentSpec.isIsProfile());
+        assertEquals("Actor", cmdComponentSpec.getCMDComponent().get(0).getName());
+
+        // Spec copy should be a freshly unmarshalled copy
+        final CMDComponentSpec specCopy = validator.getCopyOfCMDComponentSpec();
+        assertNotSame(cmdComponentSpec, specCopy);
+
+        // Content should still match XML
+        assertTrue(specCopy.isIsProfile());
+        assertEquals("Actor", specCopy.getCMDComponent().get(0).getName());
+    }
+
+    private MDValidator getValidProfileValidator() {
+        final String profileContent = getValidProfileString();
+        InputStream input = new ByteArrayInputStream(profileContent.getBytes());
+        ProfileDescription desc = ProfileDescription.createNewDescription();
+        MDValidator validator = new MDValidator(input, desc, publicRegistry, null, publicRegistry);
+        return validator;
+    }
+
+    private String getValidProfileString() {
+        String profileContent = "";
+        profileContent += "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
+        profileContent += "<CMD_ComponentSpec isProfile=\"true\" xmlns:xml=\"http://www.w3.org/XML/1998/namespace\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
+        profileContent += "    xsi:noNamespaceSchemaLocation=\"general-component-schema.xsd\">\n";
+        profileContent += "    <Header />\n";
+        profileContent += "    <CMD_Component name=\"Actor\" CardinalityMin=\"0\" CardinalityMax=\"unbounded\">\n";
+        profileContent += "        <CMD_Element name=\"Age\">\n";
+        profileContent += "            <ValueScheme>\n";
+        profileContent += "                <pattern>[23][0-9]</pattern>\n";
+        profileContent += "            </ValueScheme>\n";
+        profileContent += "        </CMD_Element>\n";
+        profileContent += "    </CMD_Component>\n";
+        profileContent += "</CMD_ComponentSpec>\n";
+        return profileContent;
     }
 }