Merge pull request #42 from nsip/master

v0.14.0 merged to master from AU repository.

Author: joerghuber

SIF3InfraREST/README.md

@@ -25,7 +25,7 @@ Project (note that the version number will change over time):
 <dependency>
    <groupId>sif3.framework</groupId>
    <artifactId>sif3-infra-rest</artifactId>
-   <version>0.13.0</version>
+   <version>0.14.0</version>
 </dependency>
 ```
 
@@ -174,6 +174,16 @@ new framework version.**
 
 **Please refer to the detailed release notes in "release/v0.13.0" carefully to ensure that your project is upgraded properly to the new framework version.**
 
+## Version from Jan 22, 2019: v0.14.0 - Various changes
+___
+**AS OF THIS VERSION ALL FRAMEWORK LIBRARIES ARE COMPILED WITH JAVA 8. THE FRAMEWORK MAY NO LONGER SUPPORT OR RUN ON JAVA VERSIONS OLDER THAN JAVA 8.**
+___
+- Updated some test cases to use SIF AU 3.4.4 data model (draft)
+- Added Named Query functionality (Consumer & Provider). For details on how to use Named Queries, please refer to section 5.12
+  in the Developer's Guide.
+
+**Please refer to the detailed release notes in "release/v0.14.0" carefully to ensure that your project is upgraded properly to the new framework version.**
+
 # Download Instructions
 How to download this project:
 

SIF3InfraREST/SIF3Demo/sif3-demo-web/pom.xml

@@ -1,5 +1,6 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" 
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
 	<!-- =========== -->
@@ -8,7 +9,7 @@
 	<groupId>sif3.framework</groupId>
 	<artifactId>sif3-demo-web</artifactId>
 	<packaging>war</packaging>
-	<version>0.13.0-Demo</version>
+	<version>0.14.0-Demo</version>
 	<name>SIF3 Demo Provider</name>
 
 	<!-- =============================== -->
@@ -18,8 +19,8 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
 		<!-- Set the Java Version compliance -->
-		<maven.compiler.source>1.7</maven.compiler.source>
-		<maven.compiler.target>1.7</maven.compiler.target>
+		<maven.compiler.source>1.8</maven.compiler.source>
+		<maven.compiler.target>1.8</maven.compiler.target>
 
 		<!-- Hardcoded Variable for the non-maven library location -->
 		<!--project.lib.dir>C:/Development/GitHubRepositories/SIF3InfraRest/SIF3InfraREST/lib</project.lib.dir-->
@@ -41,7 +42,7 @@
 		<dependency>
 			<groupId>sif3.framework</groupId>
 			<artifactId>sif3-infra-rest</artifactId>
-			<version>0.13.0-beta</version>
+			<version>0.14.0-beta</version>
 		</dependency>
 
 		<!-- ====================== -->
@@ -51,7 +52,7 @@
 		<dependency>
 			<groupId>sifau</groupId>
 			<artifactId>sif3-au-datamodel</artifactId>
-			<version>3.4.3</version>
+			<version>3.4.4</version>
 		</dependency>
 
 		<!-- =============================== -->
@@ -167,7 +168,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-war-plugin</artifactId>
-				<!--version>3.0.0</version-->
+				<!--version>3.2.2</version-->
 				<configuration>
 					<attachClasses>true</attachClasses>
 					<archiveClasses>true</archiveClasses>

SIF3InfraREST/SIF3Demo/sif3-demo-web/src/main/java/systemic/sif3/demo/rest/consumer/namedquery/StudentsInYearConsumer.java

@@ -0,0 +1,40 @@
+package systemic.sif3.demo.rest.consumer.namedquery;
+
+import sif3.common.model.PagingInfo;
+import sif3.common.model.StringPayload;
+import sif3.common.model.delayed.DelayedResponseReceipt;
+import sif3.common.ws.ErrorDetails;
+import sif3.infra.rest.consumer.AbstractNamedQueryConsumer;
+
+public class StudentsInYearConsumer extends AbstractNamedQueryConsumer
+{
+    public StudentsInYearConsumer()
+    {
+        super();
+    }
+    
+    @Override
+    public String getNamedQueryName()
+    {
+        return "StudentsInYear"; // Name of named query as it appears in the environment XML.
+    }
+
+    @Override
+    public void processDelayedNamedQuery(StringPayload responseData, PagingInfo pagingInfo, DelayedResponseReceipt receipt)
+    {
+        logger.debug("Received DELAYED NAMED QUERY Response:\nPagingInfo:\n"+pagingInfo+"\nDelayed Receipt Details:\n"+receipt+"\nResponse Data:\n"+responseData);
+    }
+
+    @Override
+    public void processDelayedError(ErrorDetails error, DelayedResponseReceipt receipt)
+    {
+        logger.debug("Received DELAYED ERROR Response:\n"+error+"\nDelayed Receipt Details:\n"+receipt);
+    }
+
+    @Override
+    public void shutdown()
+    {
+        logger.info("Shutting down Named Query Service Consumer '"+getNamedQueryName()+"'");
+    }
+
+}

SIF3InfraREST/SIF3Demo/sif3-demo-web/src/main/java/systemic/sif3/demo/rest/provider/namedquery/StudentsInYearProvider.java

@@ -0,0 +1,96 @@
+/*
+ * StudentsInYear.java
+ * Created: 4 Dec 2018
+ *
+ * Copyright 2018 Systemic Pty Ltd
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License. 
+ */
+
+package systemic.sif3.demo.rest.provider.namedquery;
+
+import javax.ws.rs.core.MediaType;
+
+import sif3.common.exception.DataTooLargeException;
+import sif3.common.exception.PersistenceException;
+import sif3.common.exception.SIFException;
+import sif3.common.exception.UnsupportedMediaTypeExcpetion;
+import sif3.common.model.PagingInfo;
+import sif3.common.model.QueryTemplateInfo;
+import sif3.common.model.RequestMetadata;
+import sif3.common.model.ResponseParameters;
+import sif3.common.model.SIFContext;
+import sif3.common.model.SIFZone;
+import sif3.common.model.StringPayload;
+import sif3.infra.rest.provider.namedquery.BaseNamedQueryProvider;
+
+/**
+ * @author Joerg Huber
+ *
+ */
+public class StudentsInYearProvider extends BaseNamedQueryProvider
+{
+
+    /* 
+     * @see sif3.common.interfaces.NamedQueryProvider#retrieveData(sif3.common.model.QueryTemplateInfo, sif3.common.model.SIFZone, sif3.common.model.SIFContext, sif3.common.model.PagingInfo, sif3.common.model.RequestMetadata, sif3.common.model.ResponseParameters, javax.ws.rs.core.MediaType)
+     */
+    @Override
+    public StringPayload retrieveData(QueryTemplateInfo queryTemplateInfo,
+                                      SIFZone zone, 
+                                      SIFContext context, 
+                                      PagingInfo pagingInfo, 
+                                      RequestMetadata metadata,
+                                      ResponseParameters customResponseParams, 
+                                      MediaType returnMimeType)
+            throws PersistenceException, UnsupportedMediaTypeExcpetion, DataTooLargeException, SIFException
+    {
+        logger.debug("StudentsInYearProvider.retrieveData request received with QueryTemplateInfo:\n"+queryTemplateInfo);
+        if(returnMimeType.isCompatible(MediaType.APPLICATION_JSON_TYPE))
+        {
+            throw new UnsupportedMediaTypeExcpetion("JSON not supported for "+getServiceName()+" named query.");
+        }
+        StringPayload response = new StringPayload();
+        response.setMimeType(returnMimeType);
+        
+        response.setData( 
+        "<Students xmlns=\"http://www.au/StudentInYear/3.4.2\">\n"+
+        "    <school>4001</school>\n"+
+        "  <Student>\n"+
+        "    <LogonId>dan.petersen</LogonId>\n"+
+        "  </Student>\n"+
+        "  <Student>\n"+
+        "    <LogonId>leila.stone</LogonId>\n"+
+        "  </Student>\n"+
+        "</Students>"); 
+
+        return response;
+    }
+
+    /* Name of the service as it appears in the environment or the end-point.
+     * 
+     * (non-Javadoc)
+     * @see sif3.infra.rest.provider.CoreProvider#getServiceName()
+     */
+    @Override
+    public String getServiceName()
+    {
+        return "StudentsInYear";
+    }
+
+    /* (non-Javadoc)
+     * @see sif3.infra.rest.provider.CoreProvider#shutdown()
+     */
+    @Override
+    public void shutdown()
+    {
+        logger.debug("Shutdown Named Query Service for " + getPrettyName()); 
+    }
+}

SIF3InfraREST/SIF3Demo/sif3-demo-web/src/test/java/sif3/test/infra/rest/consumer/TestRolloverStudentConsumer.java

@@ -168,12 +168,14 @@ private  org.w3c.dom.Element createInitPayload()
 
             org.w3c.dom.Element child = domDocument.createElement("property");
             child.setAttribute("name", "contextId");
-            child.setTextContent("future");
+//            child.setTextContent("future");
+            child.appendChild(domDocument.createTextNode("future"));
             rootElement.appendChild(child);
 
             child = domDocument.createElement("property");
             child.setAttribute("name", "initiator");
-            child.setTextContent("user1");
+//            child.setTextContent("user1");
+            child.appendChild(domDocument.createTextNode("user1"));
             rootElement.appendChild(child);
 
             return rootElement;
@@ -508,7 +510,7 @@ public static void main(String[] args)
             //
             // Job Operations
             //
-//            tester.createJob(consumer);
+            tester.createJob(consumer);
 //            tester.createJobs(consumer);
 
 
@@ -522,7 +524,7 @@ public static void main(String[] args)
             //
             // Phase State Operations
             //
-            tester.updateJobPhaseState(consumer, "oldYearEnrolment", PhaseState.PENDING);
+//            tester.updateJobPhaseState(consumer, "oldYearEnrolment", PhaseState.PENDING);
 //            tester.getJobPhaseStates(consumer, "newYearEnrolment");
 
             //