Changeset 1187 for MDService2

Timestamp:

04/01/11 20:04:33 (13 years ago)

Author:

gaba

Message:

repository param by name, Diagnostics basic version

Location:

MDService2/trunk/MDService2

Files:

• WebContent/Exception.jsp (modified) (1 diff)
• WebContent/ExceptionXML.jsp (added)
• WebContent/scripts/mdservice_ui.js (modified) (1 diff)
• src/eu/clarin/cmdi/mdservice/action/AdminAction.java (modified) (2 diffs)
• src/eu/clarin/cmdi/mdservice/action/GenericProxyAction.java (modified) (8 diffs)
• src/eu/clarin/cmdi/mdservice/action/SRUProxyAction.java (modified) (11 diffs)
• src/eu/clarin/cmdi/mdservice/model/Diagnostic.java (added)
• src/eu/clarin/cmdi/mdservice/model/Diagnostics.java (added)
• src/struts.xml (modified) (3 diffs)
• src/xsl/cmd_functions.xsl (modified) (1 diff)
• src/xsl/mdset2view.xsl (modified) (1 diff)
• src/xsl/model2matrix.xsl (modified) (3 diffs)
• src/xsl/params.xsl (modified) (1 diff)

MDService2/trunk/MDService2/WebContent/Exception.jsp

@@ -11 +11 @@
 <h2>MDService2: An error has occurred</h2>
 <hr/>
-<!-- <h3>Error Message</h3><span id="err_details_caller">details</span> -->
+
 <s:property value="userMsg"/><br/>
 <s:actionerror/>

MDService2/trunk/MDService2/WebContent/scripts/mdservice_ui.js

@@ -53 +53 @@
 function getSelectedRepository(){
         //var id = parseInt($('#repositories_select').find("option:selected").val());
-        return $('#repositories_select').find("option:selected").val();
+        return $('#repositories_select').find("option:selected").text();//val();
 
 }

MDService2/trunk/MDService2/src/eu/clarin/cmdi/mdservice/action/AdminAction.java

@@ -29 +29 @@
         @Override
         protected void  initialize(){
-                setRepository(0);
+                setRepositoryByIndex(0);
          }
         public String getDate() {
@@ -79 +79 @@
                                 clear_params.put("type", getActionkey());       
                         }
-                        if (this.getRepository() != 0){
+                        if (this.getRepository() != null){
                                 clear_params.put("repository", String.valueOf(getRepository()));        
                         }       

MDService2/trunk/MDService2/src/eu/clarin/cmdi/mdservice/action/GenericProxyAction.java

@@ -27 +27 @@
 import com.opensymphony.xwork2.ActionSupport;
 
+import eu.clarin.cmdi.mdservice.model.Diagnostics;
+
 /**
  * main Struts 2 controller 
@@ -42 +44 @@
         
         private static JSONArray repositories = null;
+        
+        private Diagnostics diagnostics;
+        
         /** 
          * Properties to be filled by Struts with according request-parameters
@@ -60 +65 @@
         private String actionContentType;
         private String userMsg;
-        private int repository;
+        private String repository;
         //private Map<String,Object> session;
          private HttpServletRequest request; 
@@ -70 +75 @@
          }
          
+         public void setRepositoryByIndex(int id){
+                 try {
+                                setRepositories(GenericProxyAction.createRepositories());
+                                // static repositories
+                                net.sf.json.JSONArray json = getRepositories();
+                                if (json.size() > 0){
+                                        repository = json.getJSONObject(id).getString("name");
+                                }
+                        } catch (IOException e) {
+                                // TODO Auto-generated catch block
+                                e.printStackTrace();
+                        } catch (InterruptedException e) {
+                                // TODO Auto-generated catch block
+                                e.printStackTrace();
+                        } catch (TransformerException e) {
+                                // TODO Auto-generated catch block
+                                e.printStackTrace();
+                        }
+         }
+         
          protected void  initialize(){
-                 repository = 1;
+                 //repository = 1;
+                 setRepositoryByIndex(0);                               
+         }
+         
+         public Diagnostics getDiagnostics(){
+                 return this.diagnostics;
+         }
+         
+         public void setDiagnostics(Diagnostics diagnostics){
+                 this.diagnostics = diagnostics;
+         }
+         public Diagnostics Diagnostics(){
+                 if (diagnostics == null){
+                         diagnostics  = new Diagnostics();
+                 }
+                 return this.diagnostics;
          }
         public String getQ() {
@@ -167 +207 @@
         
 
-        public void setRepository(int repository) {
+        public void setRepository(String repository) {
                 this.repository = repository;
         }
         
-        public int getRepository() {
+        public String getRepository() {
                 //default repository = 1 (set on init)
-                
                 return repository;
         }
@@ -278 +317 @@
         
         public void setRepositories(JSONArray rep){
-                this.repositories = rep;
+                GenericProxyAction.repositories = rep;
         }
         
@@ -453 +492 @@
                 net.sf.json.JSONArray json = getRepositories(); 
                 for(int i=0;i<json.size();i++){
-                        if (json.getJSONObject(i).getInt("id") == getRepository()){
+                        if (json.getJSONObject(i).getString("name").equals(getRepository())){
                                 repository_path =  json.getJSONObject(i).getString("uri");
                         }
@@ -507 +546 @@
                         hm.put("q", getQ());
                 }
-                if (getRepository() != 0){
-                hm.put("repository_id", String.valueOf(getRepository()));       
-                }
+                //if (getRepository() != null){
+                hm.put("repository_name", String.valueOf(getRepository()));     
+                //}
         
                 return hm;

MDService2/trunk/MDService2/src/eu/clarin/cmdi/mdservice/action/SRUProxyAction.java

@@ -3 +3 @@
 import java.io.BufferedInputStream;
 import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -8 +9 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.io.StringWriter;
+import java.io.UnsupportedEncodingException;
 import java.net.MalformedURLException;
 import java.net.URISyntaxException;
@@ -15 +18 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.transform.TransformerConfigurationException;
 import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.TransformerFactoryConfigurationError;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.stream.StreamResult;
 
 import net.sf.json.JSON;
@@ -26 +37 @@
 import org.apache.commons.lang.StringEscapeUtils;
 import org.apache.struts2.interceptor.ServletRequestAware;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
 
 import com.opensymphony.xwork2.ActionSupport;
 
-/**
- * main Struts 2 controller 
- * responds to requests (collections, model, recordset) 
- * by dispatching the requests to appropriate internal methods and filling the inputStream with the result
- *  
- * @author vronk
- *
- */
-public class SRUProxyAction extends ActionSupport  
+import eu.clarin.cmdi.mdservice.model.Diagnostic;
+import eu.clarin.cmdi.mdservice.model.Diagnostics;
+
+
+public class SRUProxyAction extends ActionSupport
+implements ServletRequestAware 
 {
 
         private static final long serialVersionUID = 1L;
+        
+        private Diagnostics diagnostics;
         
         /** 
          * Properties to be filled by Struts with according request-parameters
          */     
+        private String q;
         private String version;
         private String operation;
@@ -56 +72 @@
         private String sortKeys;
         private String stylesheet;      
-        private String extraRequestData;
+        private String x_cmd_repository;
+        private String x_cmd_collections;
 
         private MDRepoProxyAction mdrepoproxyaction;
         private InputStream resultStream;
+        private HttpServletRequest request; 
         
         private final static HashMap<String,String> hash_operations = new HashMap<String,String>();
@@ -76 +94 @@
          }
          
+         @Override
+                public void setServletRequest(HttpServletRequest arg0) {
+                        request = arg0;
+                }
+
+                public HttpServletRequest getServletRequest() {
+                        return request;
+                }
+                
+                public Diagnostics getDiagnostics(){
+                        return this.diagnostics;
+                }
+                
+                public void setDiagnostics(Diagnostics diagnostics){
+                        this.diagnostics = diagnostics;
+                }
+        
+                
+         public String getQ() {
+                        return q;
+                }
+
+                public void setQ(String q) {
+                        this.q = q;
+                }
+         
          public InputStream getResultStream() {
              return resultStream;
@@ -83 +127 @@
          }
         
+
         public String getVersion() {
                 return version;
@@ -170 +215 @@
         }
         
-        public String getExtraRequestData() {
-                return extraRequestData;
-        }
-
-        public void setExtraRequestData(String extraRequestData) {
-                this.extraRequestData = extraRequestData;
-        }
-
-
+        public String getX_cmd_repository(){
+                return x_cmd_repository;
+        }
+        
+        public void setX_cmd_repository(String x_cmd_repository){
+                this.x_cmd_repository = x_cmd_repository;
+        }
+
+        public String getX_cmd_collections(){
+                return x_cmd_collections;
+        }
+        
+        public void setX_cmd_collections(String x_cmd_collections){
+                this.x_cmd_collections = x_cmd_collections;
+        }
+
+        
+        public String getDiagnosticStreamName() throws TransformerConfigurationException, UnsupportedEncodingException, ParserConfigurationException, TransformerException, TransformerFactoryConfigurationError{
+                resultStream = this.Diagnostics().buildXMLStream();
+                return "resultStream";
+        }
         /**
          * primitive identification of the target-proxy
@@ -189 +246 @@
         }
         
+        public Diagnostics Diagnostics(){
+                if (this.diagnostics == null){
+                        this.diagnostics = new Diagnostics();
+                }
+                return this.diagnostics;
+        }
+        
         public void prepare(){
+                // special handling of parameter setting, x-cmd-... not alowed in java
+                this.setX_cmd_repository(getServletRequest().getParameter("x-cmd-repository"));
+                this.setX_cmd_collections(getServletRequest().getParameter("x-cmd-collections"));
+
                 mdrepoproxyaction = new MDRepoProxyAction();
-                mdrepoproxyaction.setRepository(2);
-                
+                mdrepoproxyaction.setDiagnostics(diagnostics);
+                
+                //operation
+                if (this.operation == null) {
+                        this.Diagnostics().Add(Diagnostic.MANDATORY_NOTSUPPLIED, "operation");
+                        //return -1;
+                }
+                if (!operation.equals("searchRetrieve")) {
+                        this.Diagnostics().Add(Diagnostic.UNSUPPOERTED_OPERATION, "Only searchRetrieve supported.");
+                        //return -1;
+                }
                 mdrepoproxyaction.setActionkey(hash_operations.get(this.getOperation()));
+                //version
+                if (this.version == null) {
+                        this.Diagnostics().Add(Diagnostic.MANDATORY_NOTSUPPLIED, "version");
+                        //return -1;
+                }
+                if (!version.equals("1.2")) {
+                        this.Diagnostics().Add(Diagnostic.UNSUPPORTED_VERSION, "Version 1.2 supported.");
+                        //return -1;
+                }
+                //query
                 mdrepoproxyaction.setSquery("");
+                if (this.query == null) {
+                        this.Diagnostics().Add(Diagnostic.MANDATORY_NOTSUPPLIED, "query");
+                        //return -1;
+                }
                 mdrepoproxyaction.setQ(getQuery());
+                
                 mdrepoproxyaction.setFormat("xml");
                 
-                if (getStartRecord() > 0 ){
+                if ((this.startRecord < 0 ) ||(getServletRequest().getParameter("startRecord").equals("0"))) {
+                        this.Diagnostics().Add(new Diagnostic(Diagnostic.UNSUPPORTED_PARAMETERVALUE, "startRecord must by grater than 0."));//,Diagnostic.NONFATALNONSURORGATE));
+                        //mdrepoproxyaction.setStartItem("1");
+                } else {
                         mdrepoproxyaction.setStartItem(Integer.toString(getStartRecord()));
                 }
-                if (getMaximumRecords() > 0 ) {
-                        mdrepoproxyaction.setMaximumItems(Integer.toString(this.getMaximumRecords()));
-                }
-                
+        
+                if ((this.maximumRecords < 0 ) ||(getServletRequest().getParameter("maximumRecords").equals("0"))){
+                           this.Diagnostics().Add(new Diagnostic(Diagnostic.UNSUPPORTED_PARAMETERVALUE, 
+                                           "maximumRecords must by grater than 0."));
+                } else {
+                        mdrepoproxyaction.setMaximumItems(Integer.toString(this.getMaximumRecords()));  
+                }
+                
+                if (this.getX_cmd_repository() != null ) {
+                        mdrepoproxyaction.setRepository(this.getX_cmd_repository());
+                        //TODO\
+                        if (mdrepoproxyaction.getBaseURI() == null) this.Diagnostics().Add(Diagnostic.UNSUPPORTED_PARAMETERVALUE, "Unknown repository." + getX_cmd_repository());
+                }
+                if (this.getX_cmd_collections() != null ) {
+                        mdrepoproxyaction.setCollection(this.getX_cmd_collections());
+                }
+                
+                //return 1;
         }
         public static String inputStreamAsString(InputStream stream)
@@ -220 +329 @@
         }
 
-        public void postprocess(){
+         public static Document newDocumentFromInputStream(InputStream in) {
+                    DocumentBuilderFactory factory = null;
+                    DocumentBuilder builder = null;
+                    Document ret = null;
+
+                    try {
+                      factory = DocumentBuilderFactory.newInstance();
+                      builder = factory.newDocumentBuilder();
+                    } catch (ParserConfigurationException e) {
+                      e.printStackTrace();
+                    }
+
+                    try {
+                      ret = builder.parse(new InputSource(in));
+                    } catch (SAXException e) {
+                      e.printStackTrace();
+                    } catch (IOException e) {
+                      e.printStackTrace();
+                    }
+                    return ret;
+                  }
+
+
+        public void postprocess() throws TransformerConfigurationException, UnsupportedEncodingException, ParserConfigurationException, TransformerException, TransformerFactoryConfigurationError{
                 //recordPacking
                 if (this.getRecordPacking() != null){
@@ -233 +365 @@
                         }
                 }
-        }
+                
+                // add diagnostics
+                if (Diagnostics().Exists()){
+                        Document doc = newDocumentFromInputStream(resultStream);
+                        Node r_element=  doc.getElementsByTagName("searchRetrieveResponse").item(0);
+                        Document ddoc = Diagnostics().buildXMLDocument();
+                        Node d_element=  ddoc.getElementsByTagName("diagnostics").item(0);
+                        doc.adoptNode(d_element);
+                        r_element.appendChild(d_element);
+                        DOMSource source = new DOMSource(doc);   
+                        StringWriter xmlAsWriter = new StringWriter();   
+                        StreamResult result = new StreamResult(xmlAsWriter);    
+                        TransformerFactory.newInstance().newTransformer().transform(source, result);
+                        resultStream = new ByteArrayInputStream(xmlAsWriter.toString().getBytes("UTF-8"));
+                }
+        }
+        
         /**
          * default Action method
          */
         public String execute() throws Exception {
-
                 prepare();
-                if (this.mdrepoproxyaction.execute() == SUCCESS){
-                        resultStream = this.mdrepoproxyaction.getResultStream();
-                        postprocess();
-                        return SUCCESS;
+                if (Diagnostics().Accepted()){
+                        //TODO diagnostic
+                        if (this.mdrepoproxyaction.getTargetRequest() == null) {
+                                Diagnostics().Add(Diagnostic.QUERYSYNTAXERROR);
+                                return ERROR;
+                        }
+                        if (this.mdrepoproxyaction.execute() == SUCCESS){
+                                resultStream = this.mdrepoproxyaction.getResultStream();
+                                postprocess();
+                                return SUCCESS;
+                        }
                 }
                 return ERROR;

MDService2/trunk/MDService2/src/struts.xml

@@ -13 +13 @@
                 
                 <global-results>
-                            <result name="exception">/Exception.jsp</result>
+                            <!-- <result name="exception">/Exception.jsp</result>--> 
+                            <result name="exception">/ExceptionXML.jsp</result> 
                             <!-- tried setting html-status, didn't work:  
                                 <result name="exception">
@@ -20 +21 @@
                             </result> -->
                             <result name="error">/Error.jsp</result>
+                            <!-- <result name="error" type="redirectAction"></result>
+                             --> 
                 </global-results>
 
@@ -228 +231 @@
                 <action name="sru/*" class="eu.clarin.cmdi.mdservice.action.SRUProxyAction" method="execute"> 
                            <param name="q">{1}</param>
-                           <result type="stream">                              
+                           <result name="success" type="stream">                               
                                 <param name="contentType">text/xml</param> 
                                 <param name="inputName">resultStream</param>                            
+                            </result>
+                            <result name="error" type="stream">                        
+                                <param name="contentType">text/xml</param> 
+                                <param name="inputName">${getDiagnosticStreamName()}</param>                            
                             </result>
                 </action>

MDService2/trunk/MDService2/src/xsl/cmd_functions.xsl

@@ -186 +186 @@
                 <xsl:choose>
                         <xsl:when test="$action=''">
-                                <xsl:value-of select="concat($base_dir, '/?q=', $q, '&amp;repository=', $repository_id)" />
+                                <xsl:value-of select="concat($base_dir, '/?q=', $q, '&amp;repository=', $repository_name)" />
                         </xsl:when>                     
                         <xsl:otherwise>
-                                <xsl:value-of select="concat($base_dir, '/',$action, '/', $format, '/?q=', $q, '&amp;repository=', $repository_id)" />
+                                <xsl:value-of select="concat($base_dir, '/',$action, '/', $format, '/?q=', $q, '&amp;repository=', $repository_name)" />
                         </xsl:otherwise>
                 </xsl:choose>

MDService2/trunk/MDService2/src/xsl/mdset2view.xsl

@@ -260 +260 @@
                         <xsl:choose>
                                 <xsl:when test="exists(.//MdSelfLink)" >
-                                <a class="internal" href="{concat('record/htmldetail/', my:encodePID(.//MdSelfLink), '?repository=', $repository_id)}" >
+                                <a class="internal" href="{concat('record/htmldetail/', my:encodePID(.//MdSelfLink), '?repository=', $repository_name)}" >
                                                 <xsl:value-of select="$absolute_position" />
                                 </a>

MDService2/trunk/MDService2/src/xsl/model2matrix.xsl

@@ -42 +42 @@
         </xsl:when>     
         <xsl:when test="$termset_name='Components'" >
-                <xsl:message>model2matrix.Components.repo_id: <xsl:value-of select="$repository_id" /></xsl:message>
+                <xsl:message>model2matrix.Components.repo_name: <xsl:value-of select="$repository_name" /></xsl:message>
                 <!--  get the whole Termset for every root-node (teiHeader, TCP, ...) -->
                 <Termsets>
@@ -62 +62 @@
                                         <!--  else get the full summary for given termset -->
                                         <xsl:otherwise>
-                                        <xsl:variable name="resolved_termset_uri" select="concat($model_matrix_uri,$termset_name,'&amp;maxdepth=8&amp;repository=',$repository_id)" />
+                                        <xsl:variable name="resolved_termset_uri" select="concat($model_matrix_uri,$termset_name,'&amp;maxdepth=8&amp;repository=',$repository_name)" />
                                                 <xsl:message>processing model-term($resolved_termset_uri): <xsl:value-of select="$resolved_termset_uri" /> </xsl:message>                       
                                                 <xsl:copy-of select="document($resolved_termset_uri)" /> 
@@ -134 +134 @@
 <xsl:template name="full-matrix" >
 <!--  collect all model termMatrix -->
-                <xsl:variable name="model_termsets_uri" select="concat($model_matrix_uri,'Components', '&amp;maxdepth=1&amp;repository=',$repository_id)" />
+                <xsl:variable name="model_termsets_uri" select="concat($model_matrix_uri,'Components', '&amp;maxdepth=1&amp;repository=',$repository_name)" />
         <xsl:message>full-matrix.model_termsets_uri: <xsl:value-of select="$model_termsets_uri"/>  </xsl:message>                               
                 <xsl:variable name="model_termsets" select="document($model_termsets_uri)" />

MDService2/trunk/MDService2/src/xsl/params.xsl

@@ -24 +24 @@
         
                         
-        <xsl:param name="repository_id" select="''" />
+        <xsl:param name="repository_name" select="''" />
         
         <!--  for resolving components by suffixing with @ComponentId -->