Module com.blackhillsoftware.easysmf.je
Package com.blackhillsoftware.smf.readerbuilder

Class LogstreamBuilder<T extends LogstreamBuilder<T>>

java.lang.Object
com.blackhillsoftware.smf.SmfRecordReaderBuilder
com.blackhillsoftware.smf.readerbuilder.LogstreamBuilder<T>
public class LogstreamBuilder<T extends LogstreamBuilder<T>> extends SmfRecordReaderBuilder
Build a SmfRecordReader to read from a logstream.

See IBM documentation "JCL for the LOGR Subsystem" for a description of how the LOGR subsystem processes the start and end times.

Obtain the LogstreamReaderBuilder from SmfRecordReader.logstreamBuilder(String)

  • Method Details

    • from

      public LogstreamBuilderLocal<?> from(LocalTime localTime)
      Specify the start time for the first logstream block to be processed using a LocalTime
      Parameters:
      localTime -
      Returns:
      a LogstreamBuilderLocal to allow method chaining

    • from

      public LogstreamBuilderLocal<?> from(LocalDateTime localDateTime)
      Specify the start time for the first logstream block to be processed using a LocalDateTime
      Parameters:
      localDateTime - the start date and time
      Returns:
      a LogstreamBuilderLocal to allow method chaining

    • to

      public LogstreamBuilderLocal<?> to(LocalTime localTime)
      Specify the end time for the last logstream block to be processed using a LocalTime
      Parameters:
      localTime -
      Returns:
      a LogstreamBuilderLocal to allow method chaining

    • to

      public LogstreamBuilderLocal<?> to(LocalDateTime localDateTime)
      Specify the end time for the last logstream block to be processed using a LocalDateTime
      Parameters:
      localDateTime - the end date and time
      Returns:
      a LogstreamBuilderLocal to allow method chaining

    • from

      public LogstreamBuilderGmt<?> from(ZonedDateTime zonedDateTime)
      Specify the start time for the first logstream block to be processed using a ZonedDateTime. The Zone does not need to be UTC - the value will be converted to UTC before it is used with the LOGR subsystem.
      Parameters:
      zonedDateTime - the start date and time
      Returns:
      a LogstreamBuilderGmt to allow method chaining

    • to

      public LogstreamBuilderGmt<?> to(ZonedDateTime zonedDateTime)
      Specify the end time for the last logstream block to be processed using a ZonedDateTime. The Zone does not need to be UTC - the value will be converted to UTC before it is used with the LOGR subsystem.
      Parameters:
      zonedDateTime - the end date and time
      Returns:
      a LogstreamBuilderGmt to allow method chaining

    • sid

      public LogstreamBuilder<T> sid(String sid)
      Specify the system identifier for the SMF logstream system exit
      Parameters:
      sid - a System ID
      Returns:
      this LogstreamReaderBuilderCommon to allow method chaining

    • smep

      public LogstreamBuilder<T> smep(Duration smep)
      Specify the smart end point used by the SMF logstream system exit
      Parameters:
      smep - the smart end point duration (less than or equal to 2 hours)
      Returns:
      this SmfRecordReaderBuilder to allow method chaining

    • include

      public LogstreamBuilder<T> include(int smfType)
      Description copied from class: SmfRecordReaderBuilder
      Include a SMF record type - see SmfRecordReader.include(int)
      Specified by:
      include in class SmfRecordReaderBuilder
      Parameters:
      smfType - the SMF type to include
      Returns:
      this SmfRecordReaderBuilder to allow method chaining

    • include

      public LogstreamBuilder<T> include(int smfType, int subtype)
      Description copied from class: SmfRecordReaderBuilder
      Include a SMF record type and subtype - see SmfRecordReader.include(int, int)
      Specified by:
      include in class SmfRecordReaderBuilder
      Parameters:
      smfType - the SMF type to include
      subtype - the SMF subtype to include
      Returns:
      this SmfRecordReaderBuilder to allow method chaining

    • build

      public SmfRecordReader build() throws IOException
      Description copied from class: SmfRecordReaderBuilder
      Build the SmfRecordReader. Consider calling this method in a try-with-resources statement to ensure the SmfRecordReader is closed.
      Specified by:
      build in class SmfRecordReaderBuilder
      Returns:
      the resulting SmfRecordReader
      Throws:
      IOException - if an I/O error occurs