Index (JES Client 0.9.4-SNAPSHOT API)

C D E F G H J L P R S T V W

C

canEqual(Object) - Method in exception de.larssh.jes.JesLimitReachedException
canEqual(Object) - Method in class de.larssh.jes.Job
canEqual(Object) - Method in class de.larssh.jes.JobOutput
close() - Method in class de.larssh.jes.JesClient: Logs out and disconnects the FTP connection.
createFileEntryParser(String) - Method in class de.larssh.jes.parser.DebuggingFtpFileEntryParserFactory
createFileEntryParser(FTPClientConfig) - Method in class de.larssh.jes.parser.DebuggingFtpFileEntryParserFactory
createFileEntryParser(String) - Method in class de.larssh.jes.parser.JesFtpFileEntryParserFactory
createFileEntryParser(FTPClientConfig) - Method in class de.larssh.jes.parser.JesFtpFileEntryParserFactory
createOutput(int, String, int, Optional<String>, Optional<String>, Optional<String>) - Method in class de.larssh.jes.Job: Creates a JobOutput and adds it to the list of job outputs.

D

de.larssh.jes - package de.larssh.jes: Handling of z/OS JES spools using Java technologies
de.larssh.jes.parser - package de.larssh.jes.parser: JES implementation of FTPFileEntryParser
DebuggingFtpFileEntryParser - Class in de.larssh.jes.parser: Implementation of FTPFileEntryParser throwing at each method to simplify debugging wrapped FTP connections
DebuggingFtpFileEntryParser() - Constructor for class de.larssh.jes.parser.DebuggingFtpFileEntryParser
DebuggingFtpFileEntryParserException - Exception in de.larssh.jes.parser: Thrown to indicate that a FTPFileEntryParser function is called.
DebuggingFtpFileEntryParserException(String, String) - Constructor for exception de.larssh.jes.parser.DebuggingFtpFileEntryParserException: Constructs a new DebuggingFtpFileEntryParserException for the given method name and its stringified value.
DebuggingFtpFileEntryParserFactory - Class in de.larssh.jes.parser: Factory implementation to create implementations of DebuggingFtpFileEntryParser.
DebuggingFtpFileEntryParserFactory() - Constructor for class de.larssh.jes.parser.DebuggingFtpFileEntryParserFactory
delete(Job) - Method in class de.larssh.jes.JesClient: Removes a given job from JES spool.

E

enterJesMode() - Method in class de.larssh.jes.JesClient: Enters the IBM z/OS FTP servers JES file type mode using a SITE command.
equals(Object) - Method in exception de.larssh.jes.JesLimitReachedException
equals(Object) - Method in class de.larssh.jes.Job
equals(Object) - Method in class de.larssh.jes.JobOutput
exists(Job, JobStatus) - Method in class de.larssh.jes.JesClient: Reloads the job from server and returns true if the job is still available and matches the given job status.

F

FILTER_WILDCARD - Static variable in class de.larssh.jes.JesClient: Wildcard value to be used for name and owner filters, meaning "any" value.

G

getAbendCode() - Method in class de.larssh.jes.Job: The jobs abend code This field can be present for JobStatus.OUTPUT (and JobStatus.ALL) only.
getFlags() - Method in class de.larssh.jes.Job: The jobs flags
getFtpClient() - Method in class de.larssh.jes.JesClient: FTP Client used by the current JES client instance.
getId() - Method in class de.larssh.jes.Job: The jobs ID, must not be empty
getIndex() - Method in class de.larssh.jes.JobOutput: The job outputs index inside the jobs list of outputs (starting at 1)
getJesClass() - Method in class de.larssh.jes.Job: The jobs JES spool class
getJesOwner() - Method in class de.larssh.jes.JesClient: Current JES spool user
getJob() - Method in class de.larssh.jes.JobOutput: Corresponding Job
getJob() - Method in class de.larssh.jes.parser.JesFtpFile: Job details
getJobDetails(Job) - Method in class de.larssh.jes.JesClient: Retrieves up-to-date job details for job.
getJobs() - Method in exception de.larssh.jes.JesLimitReachedException: List of jobs up to the limit
getLength() - Method in class de.larssh.jes.JobOutput: The job outputs content length
getLimit() - Method in exception de.larssh.jes.JesLimitReachedException: Limit of spool entries
getMessage() - Method in exception de.larssh.jes.JesLimitReachedException
getMethodName() - Method in exception de.larssh.jes.parser.DebuggingFtpFileEntryParserException: The called methods name
getName() - Method in class de.larssh.jes.Job: The jobs name Depending on the objects creating code this might be a filter value, eventually containing JesClient.FILTER_WILDCARD.
getName() - Method in class de.larssh.jes.JobOutput: The job outputs data division name
getOutput(String) - Method in class de.larssh.jes.Job: Returns the job output details referenced by name or Optional.empty() if no such job output exists.
getOutputClass() - Method in class de.larssh.jes.JobOutput: The job outputs class
getOutputs() - Method in class de.larssh.jes.Job: List of job output details Can be filled by Job.createOutput(int, String, int, Optional, Optional, Optional) and must be empty for status other than JobStatus.OUTPUT (and JobStatus.ALL).
getOwner() - Method in class de.larssh.jes.Job: The jobs owner Depending on the objects creating code this might be a filter value, eventually containing JesClient.FILTER_WILDCARD.
getProcedureStep() - Method in class de.larssh.jes.JobOutput: The job outputs procedure step name
getRestPattern() - Method in enum de.larssh.jes.JobFlag: Pattern used for JES communication to parse jobs rest values
getResultCode() - Method in class de.larssh.jes.Job: The jobs result code This field can be present for JobStatus.OUTPUT (and JobStatus.ALL) only.
getServerProperties() - Method in class de.larssh.jes.JesClient: Retrieves and parses a map of server properties, such as "JESJOBNAME", "JESSTATUS", "JESOWNER" and "INTERFACELEVEL".
getStatus() - Method in class de.larssh.jes.Job: The jobs status
getStep() - Method in class de.larssh.jes.JobOutput: The job outputs step name
getValue() - Method in enum de.larssh.jes.JobStatus: Value to be used for JES communication
getValue() - Method in exception de.larssh.jes.parser.DebuggingFtpFileEntryParserException: The stringified value supplied to the called method

H

hashCode() - Method in exception de.larssh.jes.JesLimitReachedException
hashCode() - Method in class de.larssh.jes.Job
hashCode() - Method in class de.larssh.jes.JobOutput

J

JesClient - Class in de.larssh.jes: This class allows to handle IBM z/OS JES spools using Java technologies.
JesClient() - Constructor for class de.larssh.jes.JesClient: Expert constructor.
JesClient(String, int, String, String) - Constructor for class de.larssh.jes.JesClient: Simplified constructor.
JesException - Exception in de.larssh.jes: Thrown to indicate that a logical JES exception occurred.
JesException(String, Object...) - Constructor for exception de.larssh.jes.JesException: Constructs a new JesException with the given message, formatting as described at Strings.format(String, Object...).
JesException(FTPClient, String, Object...) - Constructor for exception de.larssh.jes.JesException: Constructs a new JesException with the given message, formatting as described at Strings.format(String, Object...), appending the latest FTP reply string.
JesFtpFile - Class in de.larssh.jes.parser: FTPFile implementation to hold a Job object.
JesFtpFile(Job, String) - Constructor for class de.larssh.jes.parser.JesFtpFile: Creates a file containing a Job object and sets the original FTP server raw listing from which the job was created.
JesFtpFileEntryParser - Class in de.larssh.jes.parser: Implementation of FTPFileEntryParser for IBM z/OS JES spools, converting that information into a JesFtpFile instance.
JesFtpFileEntryParser() - Constructor for class de.larssh.jes.parser.JesFtpFileEntryParser
JesFtpFileEntryParserException - Exception in de.larssh.jes.parser: Thrown to indicate that parsing the JES job list failed.
JesFtpFileEntryParserException(String, Object...) - Constructor for exception de.larssh.jes.parser.JesFtpFileEntryParserException: Constructs a new JesFtpFileEntryParserException with the given message, formatting as described at Strings.format(String, Object...).
JesFtpFileEntryParserFactory - Class in de.larssh.jes.parser: Factory implementation to create implementations of JesFtpFileEntryParser.
JesFtpFileEntryParserFactory() - Constructor for class de.larssh.jes.parser.JesFtpFileEntryParserFactory
JesLimitReachedException - Exception in de.larssh.jes: Thrown to indicate that a JES limit has been reached and contains the job entries up to the specified JES limit.
JesLimitReachedException(int, List<Job>, FTPClient) - Constructor for exception de.larssh.jes.JesLimitReachedException: Constructs a new JesLimitReachedException with a default detail message and a given list of jobs up to the limit of spool entries.
Job - Class in de.larssh.jes: Value object containing a jobs status information.
Job(String, String, JobStatus, String) - Constructor for class de.larssh.jes.Job: This constructor creates a Job in its simplest form.
Job(String, String, JobStatus, String, Optional<String>, OptionalInt, Optional<String>, JobFlag...) - Constructor for class de.larssh.jes.Job: This constructor creates a Job allowing to set any field.
JobFieldInconsistentException - Exception in de.larssh.jes: Thrown to indicate that fields of a Job or JobOutput object are inconsistent.
JobFieldInconsistentException(String, Object...) - Constructor for exception de.larssh.jes.JobFieldInconsistentException: Constructs a new JobFieldInconsistentException with the given message, formatting as described at Strings.format(String, Object...).
JobFlag - Enum in de.larssh.jes: This enumeration contains job flags, such as special status a job can be in.
JobOutput - Class in de.larssh.jes: Value object containing a job outputs details.
JobOutput(Job, int, String, int, Optional<String>, Optional<String>, Optional<String>) - Constructor for class de.larssh.jes.JobOutput: This constructor creates a JobOutput.
JobStatus - Enum in de.larssh.jes: This enumeration contains all JES job status.

L

list(String) - Method in class de.larssh.jes.JesClient: Returns a list of all job IDs boxed into Job objects matching the given filters.
list(String, JobStatus) - Method in class de.larssh.jes.JesClient: Returns a list of all job IDs boxed into Job objects matching the given filters.
list(String, JobStatus, String) - Method in class de.larssh.jes.JesClient: Returns a list of all job IDs boxed into Job objects matching the given filters.
list(String, JobStatus, String, int) - Method in class de.larssh.jes.JesClient: Returns a list of all job IDs boxed into Job objects matching the given filters.
LIST_LIMIT_MAX - Static variable in class de.larssh.jes.JesClient: Maximum limit of spool entries (including)
listFilled(String) - Method in class de.larssh.jes.JesClient: Returns a list of all Job objects matching the given filters.
listFilled(String, JobStatus) - Method in class de.larssh.jes.JesClient: Returns a list of all Job objects matching the given filters.
listFilled(String, JobStatus, String) - Method in class de.larssh.jes.JesClient: Returns a list of all Job objects matching the given filters.
listFilled(String, JobStatus, String, int) - Method in class de.larssh.jes.JesClient: Returns a list of all Job objects matching the given filters.
login(String, String) - Method in class de.larssh.jes.JesClient: Shortcut method to perform a FTP login, set the internal JES owner and enter JES mode.

P

parseFTPEntry(String) - Method in class de.larssh.jes.parser.DebuggingFtpFileEntryParser
parseFTPEntry(String) - Method in class de.larssh.jes.parser.JesFtpFileEntryParser
preParse(List<String>) - Method in class de.larssh.jes.parser.DebuggingFtpFileEntryParser
preParse(List<String>) - Method in class de.larssh.jes.parser.JesFtpFileEntryParser

R

readNextEntry(BufferedReader) - Method in class de.larssh.jes.parser.DebuggingFtpFileEntryParser
readNextEntry(BufferedReader) - Method in class de.larssh.jes.parser.JesFtpFileEntryParser
retrieve(JobOutput) - Method in class de.larssh.jes.JesClient: Retrieves the content of jobOutput.
retrieveOutputs(Job) - Method in class de.larssh.jes.JesClient: Retrieves all job outputs of job.

S

setJesFilters(String, JobStatus, String, int) - Method in class de.larssh.jes.JesClient: Sends FTPCmd.SITE commands to set the given filter values.
setJesOwner(String) - Method in class de.larssh.jes.JesClient: Current JES spool user
submit(String) - Method in class de.larssh.jes.JesClient: Submits the given JCL and returns a related Job object containing the started jobs ID.

T

throwIfLimitReached(int, List<Job>) - Method in class de.larssh.jes.JesClient: In case the last FTP responses string contains the spool entries limit warning, a JesLimitReachedException is thrown, else jobs are returned.
toString() - Method in exception de.larssh.jes.JesLimitReachedException
toString() - Method in class de.larssh.jes.Job
toString() - Method in class de.larssh.jes.JobOutput
toString() - Method in class de.larssh.jes.parser.JesFtpFile

V

valueOf(String) - Static method in enum de.larssh.jes.JobFlag: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.larssh.jes.JobStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.larssh.jes.JobFlag: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.larssh.jes.JobStatus: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitFor(Job, Duration, Duration) - Method in class de.larssh.jes.JesClient: Waits for job to be finished using Thread#sleep(long) for waiting between JesClient.exists(Job, JobStatus) calls and timing out after a given duration.
waitFor(Job, Duration, Duration, Consumer<Duration>) - Method in class de.larssh.jes.JesClient: Waits for job to be finished using wait for waiting between JesClient.exists(Job, JobStatus) calls and timing out after a given duration.

C D E F G H J L P R S T V W