Package dev.galasa.cicsts.cicsresource

Interface IJvmprofile

public interface IJvmprofile
Represents a CICS JVM server JVM profile

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    appendProfileValue(String key, String value)
    Append a value to a JVM server option or JVM system property in the JVM profile of the format key=value in the JVM profile.
    void
    build()
    Build the JVM profile on the zOS UNIX file system
    boolean
    containsOption(String option)
    Returns true it the current JVM profile object contains the given option
    void
    delete()
    Delete the JVM profile on the zOS UNIX file system
    String
    getJvmProfileDir()
    Returns the location for the JVM profile Directory
    IZosUNIXFile
    getProfile()
    Returns the JVM profile as a IZosUNIXFile object
    Map<String,String>
    getProfileMap()
    Returns a Map of the JVM server options and JVM system property in the JVM profile
    String
    getProfileName()
    Returns the JVM profile name in the JVM server resource definition
    String
    getProfileString()
    Returns a String of the JVM server options and JVM system property in the JVM profile
    String
    getProfileValue(String key)
    Returns the value of a JVM server option or JVM system property in the JVM profile
    String
    getWlpAutoconfigure()
    Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.autoconfigure JVM system property in the JVM profile
    String
    getWlpInstallDir()
    Returns the value of the WLP_INSTALL_DIR environment variable in the JVM profile
    String
    getWlpOutputDir()
    Returns the value of the WLP_OUTPUT_DIR environment variable in the JVM profile
    String
    getWlpServerHost()
    Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.host JVM system property in the JVM profile
    String
    getWlpServerHttpPort()
    Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.http.port JVM system property in the JVM profile
    String
    getWlpServerHttpsPort()
    Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.https.port JVM system property in the JVM profile
    String
    getWlpServerName()
    Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.name JVM system property in the JVM profile
    boolean
    getWlpServerWabEnabled()
    Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.wab JVM system property in the JVM profile
    String
    getWlpUserDir()
    Returns the value of the WLP_USER_DIR environment variable in the JVM profile
    void
    printProfile()
    Print the content of the JVM profile
    void
    removeProfileValue(String key)
    Removes the JVM server option or JVM system property from the JVM profile
    void
    saveToResultsArchive(String rasPath)
    Store the content JVM profile on the zOS UNIX system to the Results Archive Store
    void
    setJvmProfileDir(String jvmProfileDir)
    Set the location for the JVM profile on the zOS UNIX file system.
    WARNING: This should must equal to the CICS region JVMPROFILEDIR SIT parameter
    void
    setProfileName(String name)
    Set the JVM profile name in the JVM server resource definition
    void
    setProfileValue(String key, String value)
    Sets JVM server option or JVM system property in the JVM profile of the format key=value.
    If the key exists, it will be replaced.
    void
    setWlpAutoconfigure(boolean autoconfigure)
    Set the value of the -Dcom.ibm.cics.jvmserver.wlp.autoconfigure JVM system property in the JVM profile
    void
    setWlpInstallDir(String wlpInstallDir)
    Set the value of the WLP_INSTALL_DIR environment variable in the JVM profile Galasa sets the default value ofUSSHOME/wlp
    void
    setWlpOutputDir(String wlpOutputDir)
    Set the value of the WLP_OUTPUT_DIR environment variable in the JVM profile
    void
    setWlpServerHost(String hostname)
    Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.host JVM system property in the JVM profile
    void
    setWlpServerHttpPort(int httpPort)
    Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.http.port JVM system property in the JVM profile
    void
    setWlpServerHttpsPort(int httpsPort)
    Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.https.port JVM system property in the JVM profile
    void
    setWlpServerName(String serverName)
    Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.name JVM system property in the JVM profile.
    void
    setWlpServerWabEnabled(boolean wabEnabled)
    Set the value of the -Dcom.ibm.cics.jvmserver.wlp.wab JVM system property in the JVM profile
    void
    setWlpUserDir(String wlpUserDir)
    Set the value of the WLP_USER_DIR environment variable in the JVM profile
    void
    setZosConnectInstallDir()
    Set the value of the ZCEE_INSTALL_DIR environment variable in the JVM profile using the value supplied in the Galasa Configuration Property Service
    void
    setZosConnectInstallDir(String zOSConnectInstallDir)
    Set the value of the ZCEE_INSTALL_DIR environment variable in the JVM profile

  • Method Details

    • setProfileName

      void setProfileName(String name) throws CicsJvmserverResourceException
      Set the JVM profile name in the JVM server resource definition
      Parameters:
      name - the profile name
      Throws:
      CicsJvmserverResourceException

    • setJvmProfileDir

      void setJvmProfileDir(String jvmProfileDir) throws CicsJvmserverResourceException
      Set the location for the JVM profile on the zOS UNIX file system.
      WARNING: This should must equal to the CICS region JVMPROFILEDIR SIT parameter
      Parameters:
      jvmProfileDir -
      Throws:
      CicsJvmserverResourceException

    • getProfile

      IZosUNIXFile getProfile()
      Returns the JVM profile as a IZosUNIXFile object
      Returns:
      the JVM profile

    • getProfileName

      String getProfileName()
      Returns the JVM profile name in the JVM server resource definition
      Returns:

    • setProfileValue

      void setProfileValue(String key, String value)
      Sets JVM server option or JVM system property in the JVM profile of the format key=value.
      If the key exists, it will be replaced. To append a value to an existing option or property, use appendProfileValue(String, String). Adding the + character before key results in the value being appended to the existing option, rather than creating a new option entry

      Examples:

      Option key value
      PRINT_JVM_OPTIONS=TRUE PRINT_JVM_OPTIONS TRUE
      -Dcom.ibm.cics.jvmserver.trace.format=FULL -Dcom.ibm.cics.jvmserver.trace.format FULL
      -Xms256M -Xms 256M
      -Xshareclasses:printStats -Xshareclasses: printStats
      -Xnocompressedrefs -Xnocompressedrefs null

      Parameters:
      key - the JVM server option or JVM system property key
      value - the JVM server option or JVM system property value

    • appendProfileValue

      void appendProfileValue(String key, String value)
      Append a value to a JVM server option or JVM system property in the JVM profile of the format key=value in the JVM profile. For example, given an existing JVM profile option of:
      OSGI_BUNDLES=/tmp/bundle1.jar
      the method call appendProfileValue("OSGI_BUNDLES", "/tmp/bundle2.jar")
      would set the option to:
      OSGI_BUNDLES=/tmp/bundle1.jar,\\\n/tmp/bundle2.jar

      If the key does not exist, then this method performs the same function as setProfileValue(String, String) *

      Parameters:
      key - the JVM server option or JVM system property key
      value - the JVM server option or JVM system property value

    • getProfileValue

      String getProfileValue(String key)
      Returns the value of a JVM server option or JVM system property in the JVM profile
      Parameters:
      key - the JVM server option or JVM system property key
      Returns:
      the JVM server option or JVM system property value

    • removeProfileValue

      void removeProfileValue(String key)
      Removes the JVM server option or JVM system property from the JVM profile
      Parameters:
      key -

    • containsOption

      boolean containsOption(String option)
      Returns true it the current JVM profile object contains the given option
      Parameters:
      option - the JVM profile option
      Returns:
      true or false

    • getProfileMap

      Map<String,String> getProfileMap()
      Returns a Map of the JVM server options and JVM system property in the JVM profile
      Returns:
      content of the JVM Profile

    • getProfileString

      String getProfileString()
      Returns a String of the JVM server options and JVM system property in the JVM profile
      Returns:
      content of the JVM Profile

    • getJvmProfileDir

      String getJvmProfileDir()
      Returns the location for the JVM profile Directory
      Returns:
      the value of the JVM Profile Directory

    • printProfile

      void printProfile()
      Print the content of the JVM profile

    • build

      void build() throws CicsJvmserverResourceException
      Build the JVM profile on the zOS UNIX file system
      Throws:
      CicsJvmserverResourceException

    • delete

      void delete() throws CicsJvmserverResourceException
      Delete the JVM profile on the zOS UNIX file system
      Throws:
      CicsJvmserverResourceException

    • saveToResultsArchive

      void saveToResultsArchive(String rasPath) throws CicsJvmserverResourceException
      Store the content JVM profile on the zOS UNIX system to the Results Archive Store
      Parameters:
      rasPath - path in Results Archive Store
      Throws:
      CicsJvmserverResourceException

    • setWlpInstallDir

      void setWlpInstallDir(String wlpInstallDir) throws CicsJvmserverResourceException
      Set the value of the WLP_INSTALL_DIR environment variable in the JVM profile Galasa sets the default value ofUSSHOME/wlp
      Parameters:
      wlpInstallDir - the value of WLP_INSTALL_DIR
      Throws:
      CicsJvmserverResourceException

    • setWlpUserDir

      void setWlpUserDir(String wlpUserDir) throws CicsJvmserverResourceException
      Set the value of the WLP_USER_DIR environment variable in the JVM profile
      Parameters:
      wlpUserDir - the value of WLP_USER_DIR
      Throws:
      CicsJvmserverResourceException

    • setWlpOutputDir

      void setWlpOutputDir(String wlpOutputDir) throws CicsJvmserverResourceException
      Set the value of the WLP_OUTPUT_DIR environment variable in the JVM profile
      Parameters:
      wlpOutputDir - the value for WLP_OUTPUT_DIR
      Throws:
      CicsJvmserverResourceException

    • setZosConnectInstallDir

      void setZosConnectInstallDir() throws CicsJvmserverResourceException
      Set the value of the ZCEE_INSTALL_DIR environment variable in the JVM profile using the value supplied in the Galasa Configuration Property Service
      Throws:
      CicsJvmserverResourceException

    • setZosConnectInstallDir

      void setZosConnectInstallDir(String zOSConnectInstallDir) throws CicsJvmserverResourceException
      Set the value of the ZCEE_INSTALL_DIR environment variable in the JVM profile
      Parameters:
      zOSConnectInstallDir - the value of ZCEE_INSTALL_DIR
      Throws:
      CicsJvmserverResourceException

    • setWlpServerName

      void setWlpServerName(String serverName) throws CicsJvmserverResourceException
      Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.name JVM system property in the JVM profile. Liberty defaults this to defaultServer.
      Parameters:
      serverName - the value for -Dcom.ibm.cics.jvmserver.wlp.server.name
      Throws:
      CicsJvmserverResourceException

    • setWlpAutoconfigure

      void setWlpAutoconfigure(boolean autoconfigure) throws CicsJvmserverResourceException
      Set the value of the -Dcom.ibm.cics.jvmserver.wlp.autoconfigure JVM system property in the JVM profile
      Parameters:
      autoconfigure - the value for -Dcom.ibm.cics.jvmserver.wlp.autoconfigure
      Throws:
      CicsJvmserverResourceException

    • setWlpServerHost

      void setWlpServerHost(String hostname) throws CicsJvmserverResourceException
      Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.host JVM system property in the JVM profile
      Parameters:
      hostname - the value of -Dcom.ibm.cics.jvmserver.wlp.server.host
      Throws:
      CicsJvmserverResourceException

    • setWlpServerHttpPort

      void setWlpServerHttpPort(int httpPort) throws CicsJvmserverResourceException
      Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.http.port JVM system property in the JVM profile
      Parameters:
      httpPort - the value of -Dcom.ibm.cics.jvmserver.wlp.server.http.port
      Throws:
      CicsJvmserverResourceException

    • setWlpServerHttpsPort

      void setWlpServerHttpsPort(int httpsPort) throws CicsJvmserverResourceException
      Set the value of the -Dcom.ibm.cics.jvmserver.wlp.server.https.port JVM system property in the JVM profile
      Parameters:
      httpsPort - the value of -Dcom.ibm.cics.jvmserver.wlp.server.https.port
      Throws:
      CicsJvmserverResourceException

    • setWlpServerWabEnabled

      void setWlpServerWabEnabled(boolean wabEnabled) throws CicsJvmserverResourceException
      Set the value of the -Dcom.ibm.cics.jvmserver.wlp.wab JVM system property in the JVM profile
      Parameters:
      wabEnabled - the value of -Dcom.ibm.cics.jvmserver.wlp.wab
      Throws:
      CicsJvmserverResourceException

    • getWlpInstallDir

      String getWlpInstallDir() throws CicsJvmserverResourceException
      Returns the value of the WLP_INSTALL_DIR environment variable in the JVM profile
      Returns:
      the value of WLP_INSTALL_DIR
      Throws:
      CicsJvmserverResourceException

    • getWlpUserDir

      String getWlpUserDir()
      Returns the value of the WLP_USER_DIR environment variable in the JVM profile
      Returns:
      the value of WLP_USER_DIR

    • getWlpOutputDir

      String getWlpOutputDir()
      Returns the value of the WLP_OUTPUT_DIR environment variable in the JVM profile
      Returns:
      the value of WLP_OUTPUT_DIR

    • getWlpServerName

      String getWlpServerName()
      Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.name JVM system property in the JVM profile
      Returns:
      the value of -Dcom.ibm.cics.jvmserver.wlp.server.name

    • getWlpAutoconfigure

      String getWlpAutoconfigure()
      Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.autoconfigure JVM system property in the JVM profile
      Returns:
      the value of -Dcom.ibm.cics.jvmserver.wlp.autoconfigure

    • getWlpServerHost

      String getWlpServerHost()
      Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.host JVM system property in the JVM profile
      Returns:
      the value of -Dcom.ibm.cics.jvmserver.wlp.server.host

    • getWlpServerHttpPort

      String getWlpServerHttpPort()
      Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.http.port JVM system property in the JVM profile
      Returns:
      the value of -Dcom.ibm.cics.jvmserver.wlp.server.http.port

    • getWlpServerHttpsPort

      String getWlpServerHttpsPort()
      Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.server.https.port JVM system property in the JVM profile
      Returns:
      the value of -Dcom.ibm.cics.jvmserver.wlp.server.https.port

    • getWlpServerWabEnabled

      boolean getWlpServerWabEnabled()
      Returns the value of the -Dcom.ibm.cics.jvmserver.wlp.wab JVM system property in the JVM profile
      Returns:
      the value of -Dcom.ibm.cics.jvmserver.wlp.wab