Package com.uc4.api.objects

Class AttributesUnix

  • All Implemented Interfaces:
    IHostAttributes
    public class AttributesUnix
extends java.lang.Object
implements IHostAttributes
    Host attributes for UNIX Jobs.

    • Constructor Summary

      Constructors 
      Constructor Description
      AttributesUnix()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int fieldCount()
      Returns the number of fields in the host attributes.
      java.lang.String getCommand()
      Returns the shell command.
      java.lang.String getShell()
      Returns the Unix Shell, under which the Job should run.
      java.lang.String getShellOptions()
      Returns shell options.
      boolean isReportDatabase()
      Returns whether the Job report transfered to the database.
      boolean isReportErrorOnly()
      Returns true if the Job report will be stored only in case of Job interruption.
      boolean isReportFile()
      Returns true if the Job report is stored in the file system on the target system.
      boolean isTypeCommand()
      Returns true if the Job type is Command.
      boolean isTypeShellScript()
      Returns true if the Job type is Shell Script.
      void load​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr, ConnectionAttributes info)
      Loads the host attributes.
      java.lang.String name()
      Returns the host attributes name.
      void setCommand​(java.lang.String command)
      Set a single shell command or sequence of shell commands.
      void setReportDatabase​(boolean reportDatabase)
      Sets whether the Job report should be transfered to the database.
      void setReportErrorOnly​(boolean reportErrorOnly)
      Sets whether the Job report should be stored only in case of Job interruption.
      void setReportFile​(boolean reportFile)
      Sets whether the Job report should be stored in the file system on the target system.
      void setShell​(java.lang.String shell)
      Sets the Unix Shell, under which the Job should run.
      void setShellOptions​(java.lang.String shellOptions)
      Specification of shell options.
      void setTypeCommand()
      The command or command sequence, stored in the "Command" field, are given to the UNIX command line.
      void setTypeShellScript()
      A Job is generated, transferred to the target system and executed as a shell script.
      void store​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes info)
      Writes the host attributes back to the XMLDocument.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AttributesUnix

        public AttributesUnix()

    • Method Detail

      • fieldCount

        public int fieldCount()
        Description copied from interface: IHostAttributes
        Returns the number of fields in the host attributes.
        Specified by:
        fieldCount in interface IHostAttributes
        Returns:
        number of fields

      • load

        public void load​(com.uc4.util.XMLDocument doc,
                 org.w3c.dom.Element hostAttr,
                 ConnectionAttributes info)
        Description copied from interface: IHostAttributes
        Loads the host attributes.
        Specified by:
        load in interface IHostAttributes
        Parameters:
        doc - XML Document containing the Job
        hostAttr - Element which contains host attributes
        info - Session details

      • name

        public java.lang.String name()
        Description copied from interface: IHostAttributes
        Returns the host attributes name.
        Specified by:
        name in interface IHostAttributes
        Returns:
        name

      • store

        public void store​(com.uc4.util.XMLDocument doc,
                  org.w3c.dom.Element objectElement,
                  ConnectionAttributes info)
        Description copied from interface: IHostAttributes
        Writes the host attributes back to the XMLDocument.
        Specified by:
        store in interface IHostAttributes
        Parameters:
        doc - Document
        objectElement - ObjectElement
        info - Session details

      • getCommand

        public java.lang.String getCommand()
        Returns the shell command.
        Returns:
        Command

      • setCommand

        public void setCommand​(java.lang.String command)
        Set a single shell command or sequence of shell commands. Is sent to the shell and executed there. Multiple commands separated by semicolons. A maximum of 255 charcters is allowed for command.
        Parameters:
        command - Command

      • getShellOptions

        public java.lang.String getShellOptions()
        Returns shell options. The syntax of the parameters for calling the shell is dependent on the respective Unix Shell.
        Returns:
        Shell options

      • setShellOptions

        public void setShellOptions​(java.lang.String shellOptions)
        Specification of shell options. The syntax of the parameters for calling the shell is dependent on the respective Unix Shell. A maximum of 16 charcters is allowed for shellOptions.
        Parameters:
        shellOptions - Shell options

      • getShell

        public java.lang.String getShell()
        Returns the Unix Shell, under which the Job should run.
        Returns:
        Unix Shell

      • setShell

        public void setShell​(java.lang.String shell)
        Sets the Unix Shell, under which the Job should run. If no shell is selected, the Automation Engine uses the standard shell from the password file. A maximum of 8 characters is allowed for shell.
        Parameters:
        shell - Unix Shell

      • isTypeCommand

        public boolean isTypeCommand()
        Returns true if the Job type is Command.
        Returns:
        Command

      • setTypeCommand

        public void setTypeCommand()
        The command or command sequence, stored in the "Command" field, are given to the UNIX command line. The shell defined in this tab is the one called. If no shell is defined, the standard shell is used.

      • isTypeShellScript

        public boolean isTypeShellScript()
        Returns true if the Job type is Shell Script.
        Returns:
        Shell Script

      • setTypeShellScript

        public void setTypeShellScript()
        A Job is generated, transferred to the target system and executed as a shell script. The JCL for the UNIX Job is stored in the "Script" tab.

      • isReportDatabase

        public boolean isReportDatabase()
        Returns whether the Job report transfered to the database.
        Returns:
        true if the Job report is transfered to the database false otherwise

      • setReportDatabase

        public void setReportDatabase​(boolean reportDatabase)
        Sets whether the Job report should be transfered to the database.
        Parameters:
        reportDatabase - true if the job report should be transfered to the database false otherwise

      • isReportErrorOnly

        public boolean isReportErrorOnly()
        Returns true if the Job report will be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.
        Returns:
        true if the job report is stored only in case of Job interruption

      • setReportErrorOnly

        public void setReportErrorOnly​(boolean reportErrorOnly)
        Sets whether the Job report should be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.
        Parameters:
        reportErrorOnly - true if the job report should be stored only in case of Job interruption

      • isReportFile

        public boolean isReportFile()
        Returns true if the Job report is stored in the file system on the target system.
        Returns:
        true if the job report is stored in the file system.

      • setReportFile

        public void setReportFile​(boolean reportFile)
        Sets whether the Job report should be stored in the file system on the target system.
        Parameters:
        reportFile - true if the job report should be stored in the file system