Package dev.galasa.zos

Interface IZosImage

public interface IZosImage

Represents a zOS Image (or lpar).

Use a ZosImage annotation to populate this field with

Author:
Michael Baylis

  • Method Details

    • getImageID

      @NotNull @NotNull String getImageID()
      Get the name of the zOS Image, may be different from the SMFID
      Returns:
      The image ID, never null

    • getSysname

      @NotNull @NotNull String getSysname()
      Get the name of the SYSNAME zOS Image. Defaults to image id
      Returns:
      The SYSNAME, never null

    • getSysplexID

      @NotNull @NotNull String getSysplexID()
      Get the name of the Sysplex this Image belongs to
      Returns:
      the sysplex id, if the sysplexid has not been defined, the imageid will be returned

    • getClusterID

      String getClusterID()
      Get the name of the Cluster this Image belongs to
      Returns:
      a String representing the cluster the image was allocated from, if it was provisioned from a cluster

    • getCodePage

      @NotNull @NotNull Charset getCodePage()
      Get the code page of this zOS Image. Defaults to 037
      Returns:
      The EBCDIC code page, never null

    • getDefaultHostname

      @NotNull @NotNull String getDefaultHostname() throws ZosManagerException
      Get the default host name for this Image
      Returns:
      a non-null String representing the default host name
      Throws:
      ZosManagerException

    • getDefaultCredentials

      @NotNull @NotNull ICredentials getDefaultCredentials() throws ZosManagerException
      Retrieve the default credentials for the zOS Image.
      Returns:
      The default credentials - see
      invalid @link 
      dev.galasa.framework.spi.creds.ICredentials
      Throws:
      ZosManagerException - if the credentials are missing or there is a problem with the credentials store

    • getIpHost

      @NotNull @NotNull IIpHost getIpHost()
      Returns:
      The default IP Host representing the zOS Image IP Stack

    • getHome

      @NotNull @NotNull String getHome() throws ZosManagerException
      Get the zOS UNIX home directory on this zOS Image for this run. Same as getRunTemporaryUNIXPath()
      Returns:
      the zOS UNIX home directory location
      Throws:
      ZosManagerException

    • getRunTemporaryUNIXPath

      @NotNull @NotNull String getRunTemporaryUNIXPath() throws ZosManagerException
      Get the path to the temporary zOS UNIX directory on this zOS Image for this run. Same as getHome()
      Returns:
      the Run Temporary UNIX Path location
      Throws:
      ZosManagerException

    • getJavaHome

      @NotNull @NotNull String getJavaHome() throws ZosManagerException
      Get the value of Java home for the image
      Returns:
      value of Java home
      Throws:
      ZosManagerException

    • getLibertyInstallDir

      @NotNull @NotNull String getLibertyInstallDir() throws ZosManagerException
      Get the value of the location of the Liberty install directory
      Returns:
      value of Liberty install directory
      Throws:
      ZosManagerException

    • getZosConnectInstallDir

      @NotNull @NotNull String getZosConnectInstallDir() throws ZosManagerException
      Get the value of the location of the zOS Connect EE install directory
      Returns:
      value of zOS Connect EE install directory
      Throws:
      ZosManagerException