Package com.uc4.api.objects
Class AttributesUnix
java.lang.Object
com.uc4.api.objects.AttributesUnix
- All Implemented Interfaces:
IHostAttributes
Host attributes for UNIX Jobs.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of fields in the host attributes.Returns the shell command.getShell()
Returns the Unix Shell, under which the Job should run.Returns shell options.boolean
Returns whether the Job report transfered to the database.boolean
Returnstrue
if the Job report will be stored only in case of Job interruption.boolean
Returnstrue
if the Job report is stored in the file system on the target system.boolean
Returnstrue
if the Job type is Command.boolean
Returnstrue
if the Job type is Shell Script.void
load
(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info) Loads the host attributes.name()
Returns the host attributes name.void
setCommand
(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
Sets the Unix Shell, under which the Job should run.void
setShellOptions
(String shellOptions) Specification of shell options.void
The command or command sequence, stored in the "Command" field, are given to the UNIX command line.void
A Job is generated, transferred to the target system and executed as a shell script.void
store
(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes info) Writes the host attributes back to theXMLDocument
.
-
Constructor Details
-
AttributesUnix
public AttributesUnix()
-
-
Method Details
-
fieldCount
public int fieldCount()Description copied from interface:IHostAttributes
Returns the number of fields in the host attributes.- Specified by:
fieldCount
in interfaceIHostAttributes
- Returns:
- number of fields
-
load
Description copied from interface:IHostAttributes
Loads the host attributes.- Specified by:
load
in interfaceIHostAttributes
- Parameters:
doc
- XML Document containing the JobhostAttr
- Element which contains host attributesinfo
- Session details
-
name
Description copied from interface:IHostAttributes
Returns the host attributes name.- Specified by:
name
in interfaceIHostAttributes
- Returns:
- name
-
store
Description copied from interface:IHostAttributes
Writes the host attributes back to theXMLDocument
.- Specified by:
store
in interfaceIHostAttributes
- Parameters:
doc
- DocumentobjectElement
- ObjectElementinfo
- Session details
-
getCommand
Returns the shell command.- Returns:
- Command
-
setCommand
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 forcommand
.- Parameters:
command
- Command
-
getShellOptions
Returns shell options. The syntax of the parameters for calling the shell is dependent on the respective Unix Shell.- Returns:
- Shell options
-
setShellOptions
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 forshellOptions
.- Parameters:
shellOptions
- Shell options
-
getShell
Returns the Unix Shell, under which the Job should run.- Returns:
- Unix Shell
-
setShell
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 forshell
.- Parameters:
shell
- Unix Shell
-
isTypeCommand
public boolean isTypeCommand()Returnstrue
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()Returnstrue
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 databasefalse
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 databasefalse
otherwise
-
isReportErrorOnly
public boolean isReportErrorOnly()Returnstrue
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()Returnstrue
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
-