Added TSQ manager and its IVT program

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICicsRegion.java

@@ -52,6 +52,7 @@ public interface ICicsRegion {
     ICemt cemt() throws CicstsManagerException;    
     ICeda ceda() throws CicstsManagerException;    
     ICeci ceci() throws CicstsManagerException;
+    ITsqFactory getTsqFactory() throws CicstsManagerException;
 
     /**
      * Provides a CICS resource instance that can then be used to create a specific CICS resource 

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ITsq.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package dev.galasa.cicsts;
+
+import javax.validation.constraints.NotNull;
+public interface ITsq {
+
+      /**
+       * Check the existence of a TSQ. 
+       * @throws TsqException if there is a problem in checking the TSQ existence
+       * @return boolean based on if TSQ is existing or not
+       */
+      public boolean exists() throws TsqException;  
+
+      /**
+       * Check if a TSQ is recoverable. 
+       * @throws TsqException if there is a problem in checking if the TSQ is recoverable or not
+       * @return boolean based on if TSQ is recoverable or not
+       */      
+      public boolean isRecoverable() throws TsqException;
+
+      /**
+       * Read Data from TSQ based on item number.
+       * @param item Item number of the TSQ to be read
+       * @return Data read from TSQ as String 
+       * @throws TsqException if there is a problem in reading from the TSQ
+       */    
+      public String readQueue(int item) throws TsqException;
+
+      /**
+       * Read next from TSQ. 
+       * @return Data read from TSQ as String 
+       * @throws TsqException if there is a problem in reading next from the TSQ
+       */    
+      public String readQueueNext() throws TsqException;
+
+      /**
+       * Write data to TSQ.  
+       * @param data The data to be written to the TSQ
+       * @throws TsqException if there is a problem in writing to the TSQ
+       */
+      public void writeQueue(@NotNull String data) throws TsqException;   
+
+      /**
+       * Delete non-recoverable TSQ. 
+       * @throws TsqException if there is a problem in deleting the TSQ
+       */
+      public void deleteQueue() throws TsqException;  
+
+}

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ITsqFactory.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package dev.galasa.cicsts;
+
+import javax.validation.constraints.NotNull;
+public interface ITsqFactory {
+
+      /**
+       * Create a new ITsq object with recoverable status   
+       * @param queueName TSQ name
+       * @param isRecoverable true for recoverable and false for non-recoverable
+       * @return ITsq object. The existence of the ITsq object does not have any correlation to whether 
+       *         the queue actually exists underneath it. It is used to access or create the ITsq.
+       * @throws TsqException if there is a problem in creating the ITsq object
+       */
+      public ITsq createQueue(@NotNull String queueName, boolean isRecoverable) throws TsqException;
+
+      /**
+       * Create a new ITsq object without recoverable status. Default recoverable status is NonRecoverable   
+       * @param queueName TSQ name
+       * @return ITsq object. The existence of the ITsq object does not have any correlation to whether 
+       *         the queue actually exists underneath it. It is used to access or create the ITsq.
+       * @throws TsqException if there is a problem in creating the ITsq object
+       */      
+      public ITsq createQueue(@NotNull String queueName) throws TsqException;   
+
+}

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/TsqException.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package dev.galasa.cicsts;
+
+/*
+ * TsqException happens for errors in the TSQ manager methods. 
+ */
+public class TsqException extends TsqManagerException {
+    private static final long serialVersionUID = 1L;
+
+    public TsqException() {
+    }
+
+    public TsqException(String message) {
+        super(message);
+    }
+
+    public TsqException(Throwable cause) {
+        super(cause);
+    }
+
+    public TsqException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public TsqException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+        super(message, cause, enableSuppression, writableStackTrace);
+    }
+
+}

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/TsqManagerException.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package dev.galasa.cicsts;
+
+/*
+ * TsqManagerException happens for errors in TSQ manager provisioning
+ */
+public class TsqManagerException extends CicstsManagerException {
+    private static final long serialVersionUID = 1L;
+
+    public TsqManagerException() {
+    }
+
+    public TsqManagerException(String message) {
+        super(message);
+    }
+
+    public TsqManagerException(Throwable cause) {
+        super(cause);
+    }
+
+    public TsqManagerException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public TsqManagerException(String message, Throwable cause, boolean enableSuppression,
+            boolean writableStackTrace) {
+        super(message, cause, enableSuppression, writableStackTrace);
+    }
+
+}

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/internal/CicstsManagerImpl.java

@@ -35,6 +35,7 @@
 import dev.galasa.cicsts.spi.ICeciProvider;
 import dev.galasa.cicsts.spi.ICedaProvider;
 import dev.galasa.cicsts.spi.ICemtProvider;
+import dev.galasa.cicsts.spi.ITsqProvider;
 import dev.galasa.cicsts.spi.ICicsRegionLogonProvider;
 import dev.galasa.cicsts.spi.ICicsRegionProvisioned;
 import dev.galasa.cicsts.spi.ICicsRegionProvisioner;
@@ -80,6 +81,7 @@ public class CicstsManagerImpl extends AbstractManager implements ICicstsManager
     private ICeciProvider ceciProvider;
     private ICedaProvider cedaProvider;
     private ICemtProvider cemtProvider;
+    private ITsqProvider tsqProvider;
     private ICicsResourceProvider cicsResourceProvider;
 
     @Override
@@ -361,6 +363,11 @@ public void registerCedaProvider(@NotNull ICedaProvider cedaProvider) {
         this.cedaProvider = cedaProvider;
     }
 
+    @Override
+    public void registerTsqProvider(@NotNull ITsqProvider tsqProvider) {
+        this.tsqProvider = tsqProvider;
+    }
+
     @Override
     public void registerCemtProvider(@NotNull ICemtProvider cemtProvider) {
         this.cemtProvider = cemtProvider;
@@ -390,6 +397,16 @@ public ICedaProvider getCedaProvider() throws CicstsManagerException {
 
         return this.cedaProvider;
     }
+
+    @Override
+    @NotNull
+    public ITsqProvider getTsqProvider() throws CicstsManagerException {
+        if (this.tsqProvider == null) {
+            throw new CicstsManagerException("No TSQ provider has been registered");
+        }
+
+        return this.tsqProvider;
+    }
 
     @Override
     @NotNull

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/internal/properties/ExtraBundles.java

@@ -1,8 +1,8 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 package dev.galasa.cicsts.internal.properties;
 
 import java.util.ArrayList;
@@ -42,6 +42,7 @@ public static List<String> get() throws CicstsManagerException {
                 list.add("dev.galasa.cicsts.ceci.manager");
                 list.add("dev.galasa.cicsts.ceda.manager");
                 list.add("dev.galasa.cicsts.cemt.manager");
+                list.add("dev.galasa.cicsts.tsq.manager");
                 list.add("dev.galasa.cicsts.resource.manager");
                 list.add("dev.galasa.zosliberty.manager");
                 list.add("dev.galasa.textscan.manager");

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/spi/BaseCicsImpl.java

@@ -1,14 +1,15 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 package dev.galasa.cicsts.spi;
 
 import dev.galasa.cicsts.CicstsManagerException;
 import dev.galasa.cicsts.ICeci;
 import dev.galasa.cicsts.ICeda;
 import dev.galasa.cicsts.ICemt;
+import dev.galasa.cicsts.ITsqFactory;
 import dev.galasa.cicsts.MasType;
 import dev.galasa.cicsts.cicsresource.CicsJvmserverResourceException;
 import dev.galasa.cicsts.cicsresource.ICicsResource;
@@ -29,6 +30,7 @@ public abstract class BaseCicsImpl implements ICicsRegionProvisioned {
     private ICeci ceci;
     private ICeda ceda;
     private ICemt cemt;
+    private ITsqFactory tsq;
     private ICicsResource cicsResource;
 	private IZosUNIXFile runTemporaryUNIXPath;
 
@@ -93,6 +95,14 @@ public ICeda ceda() throws CicstsManagerException {
         return this.ceda;
     }
 
+    @Override
+    public ITsqFactory getTsqFactory() throws CicstsManagerException {
+        if (this.tsq == null) {
+            this.tsq = this.cicstsManager.getTsqProvider().getTsqFactory(this, this.cicstsManager);
+        }
+        return this.tsq;
+    }
+
     @Override
     public ICemt cemt() throws CicstsManagerException {
         if (this.cemt == null) {

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/spi/ICicstsManagerSpi.java

@@ -1,8 +1,8 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 package dev.galasa.cicsts.spi;
 
 import java.util.List;
@@ -44,6 +44,13 @@ public interface ICicstsManagerSpi {
      * @param cedaProvider - the new provider
      */
     void registerCedaProvider(@NotNull ICedaProvider cedaProvider);
+
+    /**
+     * Register the a ITsq instance provider with the CICS TS Manager
+     * 
+     * @param tsqProvider - the new provider
+     */
+    void registerTsqProvider(@NotNull ITsqProvider tsqProvider);    
 
     /**
      * Register the a ICicsResource instance provider with the CICS TS Manager
@@ -73,6 +80,13 @@ public interface ICicstsManagerSpi {
     @NotNull
     public ICedaProvider getCedaProvider() throws CicstsManagerException;
 
+    /**
+     * @return The registered TSQ provider
+     * @throws CicstsManagerException
+     */
+    @NotNull
+    public ITsqProvider getTsqProvider() throws CicstsManagerException;    
+
     /**
      * @return The registered CICS Resource provider
      * @throws CicstsManagerException

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/spi/ITsqProvider.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package dev.galasa.cicsts.spi;
+
+import javax.validation.constraints.NotNull;
+
+import dev.galasa.cicsts.ITsqFactory;
+import dev.galasa.cicsts.TsqManagerException;
+import dev.galasa.cicsts.ICicsRegion;
+
+/**
+ * Provides CICS Region related TSQ objects
+ *
+ */
+public interface ITsqProvider {
+
+    /**
+     * Returns a unique instance of the ITsqFactory per CICS region 
+     * 
+     * @param cicsRegion
+     * @param cicstsManager
+     * @return ITsqFactory object for this CICS region, will have a different instance for different regions
+     * @throws TsqManagerException if getTsqFactory() fails
+     */
+    @NotNull
+    ITsqFactory getTsqFactory(ICicsRegion cicsRegion, ICicstsManagerSpi cicstsManager) throws TsqManagerException;
+
+}

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.tsq.manager.ivt/bnd.bnd

@@ -0,0 +1,5 @@
+-snapshot: ${tstamp}
+Bundle-Name: Galasa TSQ Manager IVTs
+Export-Package: dev.galasa.cicsts.tsq.manager.ivt
+Import-Package: !javax.validation.constraints, \
+                *

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.tsq.manager.ivt/build.gradle

@@ -0,0 +1,27 @@
+plugins {
+    id 'galasa.manager.ivt'
+}
+
+description = 'Galasa TSQ Manager IVTs'
+
+version = '0.1.0'
+
+dependencies {
+    implementation project (':galasa-managers-core-parent:dev.galasa.core.manager')
+    implementation project (':galasa-managers-cicsts-parent:dev.galasa.cicsts.tsq.manager')
+    implementation project (':galasa-managers-zos-parent:dev.galasa.zos3270.manager')
+}
+
+
+// Note: These values are consumed by the parent build process
+// They indicate which packages of functionality this OSGi bundle should be delivered inside,
+// or referenced from.
+// The settings here are gathered together by the build process to create a release.yaml file 
+// which gathers-up all the packaging metadata about all the OSGi bundles in this component.
+ext.projectName=project.name
+ext.includeInOBR          = true
+ext.includeInMVP          = true
+ext.includeInBOM          = true
+ext.includeInIsolated     = true
+ext.includeInCodeCoverage = false
+ext.includeInJavadoc      = false

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.tsq.manager.ivt/settings.gradle

@@ -0,0 +1,2 @@
+rootProject.name = 'dev.galasa.cicsts.tsq.manager.ivt'
+