Package dev.galasa.cicsts.cicsresource

Interface ICicsBundle

public interface ICicsBundle
Represents a CICS Bundle resource. It provides methods to set CICS Bundle specific attributes on the resource (via CEDA) and to manage and set attributes in CEMT

  • Method Details

    • setDefinitionDescriptionAttribute

      void setDefinitionDescriptionAttribute(String value)
      Set the CICS BUNDLE resource definition DESCRIPTION attribute value
      Parameters:
      value - the resource definition DESCRIPTION attribute value

    • setDefinitionStatusAttribute

      void setDefinitionStatusAttribute(CicsResourceStatus value)
      Set the CICS BUNDLE resource definition STATUS attribute value
      Parameters:
      value - the resource definition STATUS attribute value

    • getResourceDefinitionNameAttribute

      String getResourceDefinitionNameAttribute()
      Return the CICS BUNDLE resource definition NAME attribute value
      Returns:
      the resource definition NAME attribute value

    • getResourceDefinitionGroupAttribute

      String getResourceDefinitionGroupAttribute()
      Return the CICS BUNDLE resource definition GROUP attribute value
      Returns:
      the resource definition GROUP attribute value

    • getResourceDefinitionDescriptionAttribute

      String getResourceDefinitionDescriptionAttribute()
      Return the CICS BUNDLE resource definition DESCRIPTION attribute value
      Returns:
      the resource definition DESCRIPTION attribute value

    • getResourceDefinitionStatusAttribute

      CicsResourceStatus getResourceDefinitionStatusAttribute()
      Return the CICS BUNDLE resource STATUS attribute value
      Returns:
      the resource STATUS attribute value

    • getResourceDefinitionBundledirAttribute

      String getResourceDefinitionBundledirAttribute()
      Return the CICS BUNDLE resource BUNDLEDIR attribute value
      Returns:
      the resource JVMPROFILE attribute value

    • build

      void build() throws CicsBundleResourceException
      Build the complete JVM server including the profile zOS UNIX file and the CICS resource definition. This method will install the CICS resource and wait for it to become enabled
      Throws:
      CicsBundleResourceException

    • buildResourceDefinition

      void buildResourceDefinition() throws CicsBundleResourceException
      Build the CICS BUNDLE resource definition only
      Throws:
      CicsBundleResourceException

    • deploy

      void deploy() throws CicsBundleResourceException
      Deploy the CICS BUNDLE to the zOS UNIX file system
      Throws:
      CicsBundleResourceException

    • buildInstallResourceDefinition

      void buildInstallResourceDefinition() throws CicsBundleResourceException
      Build and install the CICS BUNDLE resource definition
      Throws:
      CicsBundleResourceException

    • installResourceDefinition

      void installResourceDefinition() throws CicsBundleResourceException
      Install the CICS BUNDLE resource definition
      Throws:
      CicsBundleResourceException

    • resourceDefined

      boolean resourceDefined() throws CicsBundleResourceException
      Check if the CICS BUNDLE resource definition exist via CEDA DISPLAY
      Returns:
      true if the resource definition exists, false otherwise
      Throws:
      CicsBundleResourceException

    • resourceInstalled

      boolean resourceInstalled() throws CicsBundleResourceException
      Check if the CICS BUNDLE resource has been installed via CEMT INQUIRE
      Returns:
      true if it has been installed, false otherwise.
      Throws:
      CicsBundleResourceException

    • enable

      void enable() throws CicsBundleResourceException
      Enable the CICS BUNDLE resource
      Throws:
      CicsBundleResourceException

    • waitForEnable

      boolean waitForEnable() throws CicsBundleResourceException
      Wait for the CICS BUNDLE resource to be enabled. Does NOT issue the enable command
      Returns:
      true if enabled, false if not enabled
      Throws:
      CicsBundleResourceException

    • waitForEnable

      boolean waitForEnable(int timeout) throws CicsBundleResourceException
      Wait for the CICS BUNDLE resource to be enabled with specified timeout. Does NOT issue the enable command
      Parameters:
      timeout - timeout in seconds
      Returns:
      true if enabled, false if not enabled
      Throws:
      CicsBundleResourceException

    • isEnabled

      boolean isEnabled() throws CicsBundleResourceException
      Returns whether the CICS BUNDLE resource is currently enabled
      Returns:
      true if enabled, false if not enabled
      Throws:
      CicsBundleResourceException

    • disable

      boolean disable() throws CicsBundleResourceException
      Disable the CICS BUNDLE resource
      Returns:
      true if disabled, false if not disabled
      Throws:
      CicsBundleResourceException

    • waitForDisable

      boolean waitForDisable() throws CicsBundleResourceException
      Wait for the CICS BUNDLE resource to be disabled. Does NOT issue the disable command
      Returns:
      true if disabled, false if not disabled
      Throws:
      CicsBundleResourceException

    • waitForDisable

      boolean waitForDisable(int timeout) throws CicsBundleResourceException
      Wait for the CICS BUNDLE resource to be disabled with specified timeout. Does NOT issue the disable command
      Parameters:
      timeout - timeout in seconds
      Returns:
      true if disabled, false if not disabled
      Throws:
      CicsBundleResourceException

    • disableDiscardInstall

      boolean disableDiscardInstall() throws CicsBundleResourceException
      Disable and discard the CICS BUNDLE resource and re-install. Waits for disable and enable Errors during the process will cause an exception to be thrown
      Returns:
      true if disabled, false if not disabled
      Throws:
      CicsBundleResourceException

    • disableDiscardInstall

      boolean disableDiscardInstall(int timeout) throws CicsBundleResourceException
      Disable and discard the CICS BUNDLE resource and re-install. Waits for disable and enable Errors during the process will cause an exception to be thrown
      Parameters:
      timeout - timeout in seconds
      Returns:
      true if disabled, false if not disabled
      Throws:
      CicsBundleResourceException

    • delete

      void delete() throws CicsBundleResourceException
      Delete the CICS BUNDLE resource including it's zOS UNIX files and directories. If the resource is installed, it will be disabled and discarded
      Throws:
      CicsBundleResourceException

    • discard

      void discard() throws CicsBundleResourceException
      Discard the CICS BUNDLE resource. If the resource is enabled, it will be disabled and discarded
      Throws:
      CicsBundleResourceException

    • disableDiscardDelete

      void disableDiscardDelete() throws CicsBundleResourceException
      Disable and discard the CICS BUNDLE resource and delete the resource definition. Errors during the process will cause an exception to be thrown
      Throws:
      CicsBundleResourceException

    • getName

      String getName()
      Returns the CICS BUNDLE name as defined in the CICS Resource Definition
      Returns:
      the CICS BUNDLE name