Package org.jenkinsci.plugins.IBM_zOS_Connector

Class SCLMSCM

java.lang.Object
hudson.scm.SCM
org.jenkinsci.plugins.IBM_zOS_Connector.SCLMSCM
All Implemented Interfaces:
ExtensionPoint, Describable<SCM>
public class SCLMSCM extends SCM

SCLMSCM

Class implementing SCM functionality for SCLM.s
Version:
1.0
Author:
Alexander Shcherbakov

  • Constructor Details

    • SCLMSCM

      @DataBoundConstructor public SCLMSCM(String server, int port, String credentialsId, boolean JESINTERFACELEVEL1, boolean FTPActiveMode, String project, String alternate, String group, String types, boolean custJobStep, String JobStep, boolean custJobHeader, String JobHeader)
      Constructor that is invoked from project configuration page.
      Parameters:
      server - LPAR name of IP address.
      port - FTP port to connect to.
      credentialsId - Credentials id..
      JESINTERFACELEVEL1 - JESINTERFACELEVEL=1?
      FTPActiveMode - FTP data transfer mode (true=active, false=passive)
      project - SCLM Project Name.
      alternate - SCLM Alternate Project Definition.
      group - SCLM Group.
      types - Types under interest (separated by comma).
      custJobStep - Whether user defines own FLMCMD job step.
      JobStep - User-supplies FLMCMD job step.
      custJobHeader - Whether user supplied own job header.
      JobHeader - User-supplied job header.

    • SCLMSCM

      public SCLMSCM()
      Dummy constructor

  • Method Details

    • getCustJobHeader

      public boolean getCustJobHeader()
      Get custJobHeader.
      Returns:
      custJobHeader

    • getCustJobStep

      public boolean getCustJobStep()
      Get custJobStep.
      Returns:
      custJobStep

    • getServer

      public String getServer()
      Get LPAR name or IP address.
      Returns:
      server

    • getPort

      public int getPort()
      Get FTP port to connect to.
      Returns:
      port

    • getCredentialsId

      public String getCredentialsId()
      Returns:
      credentials id provided.

    • getJESINTERFACELEVEL1

      public boolean getJESINTERFACELEVEL1()
      Get JESINTERFACELEVEL1.
      Returns:
      JESINTERFACELEVEL1

    • getFTPActiveMode

      public boolean getFTPActiveMode()
      Get FTPActiveMode
      Returns:
      FTPActiveMode

    • getProject

      public String getProject()
      Get SCLM Project Name.
      Returns:
      project

    • getAlternate

      public String getAlternate()
      Get SCM Alternate Project Definition.
      Returns:
      alternate

    • getGroup

      public String getGroup()
      Get SCLM Group.
      Returns:
      group

    • getJobHeader

      public String getJobHeader()
      Get Job header.
      Returns:
      JobHeader

    • getJobStep

      public String getJobStep()
      Get Job step.
      Returns:
      JobStep

    • getTypes

      public String getTypes()
      Get SCLM file types under interest.
      Returns:
      types

    • supportsPolling

      public boolean supportsPolling()
      Whether SCM supports polling.
      Overrides:
      supportsPolling in class SCM
      Returns:
      true

    • requiresWorkspaceForPolling

      public boolean requiresWorkspaceForPolling()
      Whether SCM requires workspace for polling process.
      Overrides:
      requiresWorkspaceForPolling in class SCM
      Returns:
      false

    • compareRemoteRevisionWith

      public PollingResult compareRemoteRevisionWith(@Nonnull Job<?,?> project, Launcher launcher, FilePath workspace, @Nonnull TaskListener listener, @Nonnull SCMRevisionState _baseline)
      Compare remote revision with old one.
      Overrides:
      compareRemoteRevisionWith in class SCM
      Parameters:
      project - Current project.
      launcher - Current launcher.
      workspace - Current workspace.
      listener - Current listener.
      _baseline - Old revision.
      Returns:
      PollingResult with comparison.
      See Also:

    • checkout

      public void checkout(@Nonnull Run<?,?> build, @Nonnull Launcher launcher, @Nonnull FilePath workspace, @Nonnull TaskListener listener, File changelogFile, SCMRevisionState baseline) throws IOException
      Checkout remote changes to the workspace.
      As the build itself is performed via SCLM, the checkout's main task is generation of revision.
      Overrides:
      checkout in class SCM
      Parameters:
      build - Current build.
      launcher - Current launcher.
      workspace - Current workspace.
      listener - Current listener.
      changelogFile - Current changeLogFile.
      baseline - Last revision.
      Throws:
      IOException
      See Also:

    • calcRevisionsFromBuild

      public SCMRevisionState calcRevisionsFromBuild(@Nonnull Run<?,?> build, FilePath workspace, Launcher launcher, @Nonnull TaskListener listener)
      Calculate revision from build. Dummy.
      Overrides:
      calcRevisionsFromBuild in class SCM
      Parameters:
      build - Current build.
      workspace - Current workspace.
      launcher - Current launcher.
      listener - Current listener.
      Returns:
      Actual revision.
      See Also:

    • createChangeLogParser

      public ChangeLogParser createChangeLogParser()
      Get parser for changelog.xml .
      Specified by:
      createChangeLogParser in class SCM
      Returns:
      SCLMChangeLogParser instance.

    • getDescriptor

      public SCLMSCM.SCLMSCMDescriptor getDescriptor()
      Get descriptor.
      Specified by:
      getDescriptor in interface Describable<SCM>
      Overrides:
      getDescriptor in class SCM
      Returns:
      Descriptor for SCLMSCM.