Class i5OSInstallFile

  • All Implemented Interfaces:
    OSHostable, Referenceable

    public final class i5OSInstallFile
    extends Action
    implements OSHostable
    Enables files to be installed in the Integrated File System (IFS) on a remote i5/OS system. At build time, the IFS file is added to the installer. At install time, the IFS file is restored on the target system.
    • Constructor Detail

      • i5OSInstallFile

        public i5OSInstallFile()
    • Method Detail

      • getDestination

        public java.lang.String getDestination()
        Returns the path of the location where to store the file on the target system. (By default, the path is set to the InstallAnywhere variable $OS400_INSTALL_DIR$$/$.)
      • setDestination

        public void setDestination​(java.lang.String path)
        Defines the path of the location where to store the file on the target system. (By default, the path is set to the InstallAnywhere variable $OS400_INSTALL_DIR$$/$.)
      • getExistingFilePath

        public java.lang.String getExistingFilePath()
        Returns the IFS file path to the file on the target system.
      • setExistingFilePath

        public void setExistingFilePath​(java.lang.String path)
        Defines the IFS file path to the file on the target system.
      • getDestinationRename

        public java.lang.String getDestinationRename()
        Returns the name which the file on the target system should be renamed to.
      • setDestinationRename

        public void setDestinationRename​(java.lang.String destinationRename)
        Defines the name which the file on the target system should be renamed to.
      • getRenames

        public boolean getRenames()
        Returns whether or not to rename the file on the target system.
      • setRenames

        public void setRenames​(boolean renames)
        Defines whether or not to rename the file on the target system.
      • getUninstall

        public boolean getUninstall()
        Returns whether or not uninstall the file from the target system. Default is true.
      • setUninstall

        public void setUninstall​(boolean uninstall)
        Defines whether or not uninstall the file from the target system. Default is true.
      • getUseInstalledFile

        public boolean getUseInstalledFile()
        Returns whether to use an installed file (file will be automatically bundled in to the installer) or a file that already exists in the target system.
      • setUseInstalledFile

        public void setUseInstalledFile​(boolean useInstalledFile)
        Defines whether to use an installed file (file will be automatically bundled in to the installer) or a file that already exists in the target system.
      • setFileOverwriteBehavior

        public void setFileOverwriteBehavior​(FileOverwriteBehavior fileOverwriteBehavior)
        Defines the behavior when the file already exists in the target machine.
      • getFileOverwriteBehavior

        public FileOverwriteBehavior getFileOverwriteBehavior()
        Returns the behavior when the file already exists in the target machine.
      • getSourceCcsid

        public java.lang.String getSourceCcsid()
        Returns the Coded Character Set Identifier (CCSID) for the source file. This number identifies the existing encoding of the file on the source system.
      • setSourceCcsid

        public void setSourceCcsid​(java.lang.String ccsid)
        Defines the Coded Character Set Identifier (CCSID) for the source file. This number identifies the existing encoding of the file on the source system.
      • getTargetCcsid

        public java.lang.String getTargetCcsid()
        Returns the Coded Character Set Identifier (CCSID) for the target file. This number identifies the encoding to which the installer converts the file on the target system.
      • setTargetCcsid

        public void setTargetCcsid​(java.lang.String ccsid)
        Defines the Coded Character Set Identifier (CCSID) for the target file. This number identifies the encoding to which the installer converts the file on the target system.
      • getTextConversion

        public boolean getTextConversion()
        Returns whether or not to perform text conversion (based on Coded Character Set Identifiers) on the file to install. For example, use the default values 819 (source) and 37 (target) to convert from ASCII to EBCDIC encoding. Default is false.
      • setTextConversion

        public void setTextConversion​(boolean value)
        Defines whether or not to perform text conversion (based on Coded Character Set Identifiers) on the file to install. For example, use the default values 819 (source) and 37 (target) to convert from ASCII to EBCDIC encoding. Default is false.
      • setFileSize

        public void setFileSize​(long size)
        Defines the file size.
      • getFileSize

        public long getFileSize()
        Returns the file size.
      • setSourceFile

        public void setSourceFile​(java.lang.String path)
        The path to the file to bundle in the installer.
      • getSourceFile

        public java.lang.String getSourceFile()
        The path to the file to bundle in the installer.